Docusaurus – 5 分钟为开源项目创建一个静态网站,文档、API 一应俱全

Docusaurus 是 Faecbook 专门为开源项目开发者提供的一款易于维护的静态网站创建工具,使用 Markdown 即可更新网站。青小蛙实验了一下,构建一个带有主页、文档、API、帮助 以及博客页面的静态网站,真的没用上 5 分钟。@Appinn

Docusaurus  - 5 分钟为开源项目创建一个静态网站,文档、API 一应俱全 1

来自微博好友 @Easy 同学的推荐:

FB 搞了一个专门给开源项目架网站用的 docusaurus ,用 Markdown 写,生成静态网站,可以发布到 GitHub pages。logo 还挺萌的。

说了只需要五分钟,那么来看一下怎么个 5 分钟大法:

首先,去 Vultr (此链接带返利) 开一台最便宜的 VPS,目前只有 5 刀款了,青小蛙幸运的开到了可用的日本服务器(Ubuntu)。

Docusaurus  - 5 分钟为开源项目创建一个静态网站,文档、API 一应俱全 2

然后安装 npm,这里青小蛙走了弯路,因为 apt install npm 安装的版本过低,于是使用下面几句就可以更新到最新版本了:

npm install -g npm
npm install -g n
n stable
ln -sf /usr/local/n/versions/node/9.2.1/bin/node /usr/bin/node

然后,就可以安装 Docusaurus 了,其实官网有教程啦:

git clone https://github.com/facebook/Docusaurus.git
cd Docusaurus
npm install --global docusaurus-init
docusaurus-init

好了,已经装完了,配置一下,先用 demo 跑起来:

在 Docusaurus 目录下,将 docs-examples-from-docusaurus 改名 docs,进入 website 目录,将blog-examples-from-docusaurus 改名为 blog。

然后,在 website 目录中执行 npm start,Docusaurus 就会顺利的运行在 3000 端口了,直接访问 ip:3000,就能看到下面的页面了:

Docusaurus  - 5 分钟为开源项目创建一个静态网站,文档、API 一应俱全 3

嗯,非常简单,所有内容由使用 markdown 书写的 .md 文档构成,修改起来也简单,同样官方提供了教程,比如修改 website/siteConfig.js 文件就可以更改标题、描述内容。

Docusaurus  - 5 分钟为开源项目创建一个静态网站,文档、API 一应俱全 4

有开源项目,又懒得自己写主页的同学,可以去 Docusaurus  试试啦。

后记:青小蛙最终删掉了 Vultr 的测试机器,花费 0.02 刀,嗯。

11 Comments

  1. lizhimiao 2018/01/08 Reply
  2. 迷津小人 2018/01/08 Reply
    • SaraKale 2018/07/08 Reply
      • 销锋镝铸 2018/09/29 Reply
  3. Kevin 2018/01/08 Reply
  4. Gerald 2018/01/08 Reply
  5. Lam 2018/01/08 Reply
  6. Shell32 2018/01/08 Reply
  7. Benson 2018/01/08 Reply
  8. oni 2018/01/13 Reply
    • 青小蛙 2018/01/13 Reply

Leave a Reply