1.0.12

Translate

Installation

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

  1. Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

    Node版本必须至少为 6.x, 尽管我们推荐 Node 8.x或更高版本。

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

  3. yarn global add docusaurus-init or npm install --global docusaurus-init

  4. docusaurus-init

After docusaurus is installed, moving forward, you can check your current version of Docusaurus by going into the website directory and typing npm list docusaurus. You can update to the latest version of Docusaurus by typing npm update.

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

root-of-repo
├── 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
│   └── core
│       └── Footer.js
│   └── node_modules
│   └── package.json
│   └── pages
│   └── sidebars.json
│   └── siteConfig.js
│   └── static

If you do not want to install the init script globally, you can install it locally and then run it via npx docusaurus-init or from the node_modules directory that is created via ./node_modules/.bin/docusaurus-init. You may want to remove the created package.json file and node_modules directory after you run the script.

验证安装

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.

Site Preparation →