1.2.1

Translate

Installation

Docusaurus的初始设计就是要易于安装并让你的网站可以迅速运行。 To install Docusaurus, we have created an easy script that will get all of the infrastructure set up for you:

  1. 确保您安装了最新版本的 Node。 我们同样建议您也安装 Yarn。

    您必须有 Node > = 8. x 与 Yarn > = 1.5。

  2. 进入自己Github仓库的最上级目录，您将在这里创建文档。

  3. npx docusaurus-init

    如果您没有安装 Node 8.2 + ，或是您希望在全局范围内安装 Docusaurus，请运行 yarn global add docusaurus-init 或 npm install --global docusaurus-init。 安装完成后，运行 docusaurus-init。

验证安装

Along with previously existing files and directories, your root directory will now contain a structure similar to:

root-directory
├── docs-examples-from-docusaurus
│   ├── doc1.md
│   ├── doc2.md
│   ├── doc3.md
│   ├── exampledoc4.md
│   └── exampledoc5.md
└── website
    ├── blog-examples-from-docusaurus
    │   ├── 2016-03-11-blog-post.md
    │   ├── 2017-04-10-blog-post-two.md
    │   ├── 2017-09-25-testing-rss.md
    │   ├── 2017-09-26-adding-rss.md
    │   └── 2017-10-24-new-version-1.0.0.md
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Running the Docusaurus initialization script, docusaurus-init, produces a runnable, example website to base your site upon.

  1. 在根目录中, 将 docs-examples-from-docusaurus 重命名为 docs。
  2. cd website
  3. 把 blog-examples-from-docusaurus 重命名为 blog。
  4. 通过 yarn start 或 npm start 运行本地服务器。
  5. Load the example site at http://localhost:3000. You should see the example site loaded in your web browser. There's also a LiveReload server running and any changes made to the docs and files in the website directory will cause the page to refresh.

使用代理启动服务

If you are behind a corporate proxy, you need to disable it for the development server requests. It can be done using the NO_PROXY environment variable.

SET NO_PROXY=localhost
yarn start (or npm run start)

Updating Your Docusaurus Version

After Docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing yarn outdated docusaurus or npm outdated docusaurus.

You will see something like this:

$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
warning package.json: No license field
warning No license field
info Color legend : 
 "<red>"    : Major Update backward-incompatible updates 
 "<yellow>" : Minor Update backward-compatible features 
 "<green>"  : Patch Update backward-compatible bug fixes
Package    Current Wanted Latest Package Type    URL                                          
docusaurus 1.0.9   1.2.0  1.2.0  devDependencies https://github.com/facebook/Docusaurus#readme
✨  Done in 0.41s.

如果 outdated 命令没有任何版本过期的通知，那你就处于最新版本。

You can update to the latest version of Docusaurus by:

yarn upgrade docusaurus --latest

或

npm update docusaurus

如果你在升级后发现任何错误，请尝试清除你的 Babel 缓存。通常在 temporary directory，或是在 BABEL_DISABLE_CACHE=1 的配置下运行 Docusaurus 服务（如：yarn start）。

Site Preparation →