---
title: Docusaurus  - 5 分钟为开源项目创建一个静态网站，文档、API 一应俱全
date: 2018-01-08T07:51:39Z
modified: 2018-01-08T07:53:48Z
permalink: "https://www.appinn.com/docusaurus/"
type: post
status: publish
excerpt: ""
categories:
  - 在线应用
tags:
  - 在线应用
  - facebook
  - twp
  - 开发者
  - 开源
  - 静态网站
featured_image: "https://www.appinn.com/wp-content/uploads/2018-01-08-3-23-45.pngo_.png"
author: 青小蛙
timestamp: 2018-01-08T07:53:48Z
---

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

![](https://static2.appinn.com/images/201801/2018-01-08-3-23-45.png)

来自微博好友 @[Easy](https://weibo.com/1088413295/FDhG4p0kK) 同学的推荐：

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

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

首先，去 [Vultr](https://www.vultr.com/?ref=7112193) (此链接带返利) 开一台最便宜的 VPS，目前只有 5 刀款了，青小蛙幸运的开到了可用的日本服务器（Ubuntu）。

![](https://static2.appinn.com/images/201801/2018-01-08-3-29-50.png)

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

`npm install -g npm<br></br>npm install -g n<br></br>n stable<br></br>ln -sf /usr/local/n/versions/node/9.2.1/bin/node /usr/bin/node`

然后，就可以安装 Docusaurus 了，其实官网[有教程](https://docusaurus.io/docs/en/installation.html)啦：

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

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

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

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

![](https://static2.appinn.com/images/201801/getting-started-preparation-verify.jpg)

嗯，非常简单，所有内容由使用 markdown 书写的 .md 文档构成，修改起来也简单，同样官方[提供了教程](https://docusaurus.io/docs/en/site-creation.html)，比如修改 website/siteConfig.js 文件就可以更改标题、描述内容。

![](https://ws4.sinaimg.cn/large/006tNc79gy1fn98q0eg66g30dw07lat0.gif)

有开源项目，又懒得自己写主页的同学，可以去 [Docusaurus](https://docusaurus.io/) 试试啦。

后记：青小蛙最终删掉了 [Vultr](https://www.vultr.com/?ref=7112193) 的测试机器，花费 0.02 刀，嗯。

## Topics

**分类目录:** [在线应用](https://www.appinn.com/category/online-tools/?output_format=md)

**标签:** [facebook](https://www.appinn.com/tag/facebook/?output_format=md), [twp](https://www.appinn.com/tag/twp/?output_format=md), [开发者](https://www.appinn.com/tag/%e5%bc%80%e5%8f%91%e8%80%85/?output_format=md), [开源](https://www.appinn.com/tag/%e5%bc%80%e6%ba%90/?output_format=md), [静态网站](https://www.appinn.com/tag/%e9%9d%99%e6%80%81%e7%bd%91%e7%ab%99/?output_format=md)