1.10.x

Translate

Setting Up

本教程是针对首次使用者的，详细地说明如何从零开始完成一个的Docusaurus网站。 让我们开始吧！

Docusaurus campfire {.docImage}

安装 Node.js

Node.js是一个可以在网页浏览器之外运行JavaScript代码的运行环境，并被用于编写和运行服务器端JavaScript应用程序。

Docusaurus' minimum supported Node.js version is Node 8, but more recent versions will work as well.

  1. 打开你的终端程序。
  2. 如果你安装有 brew 在你的操作系统里，运行以下命令来安装 Node（JavaScript 运行时间，允许你在服务端运行 JavaScript）和包管理工具 npm （允许你使用终端安装你项目所需要的依赖包）。
brew install node

或者，你可以从 Node.js 的官网下载安装。

检查你的 Node.js 安装情况

检查您是否已安装了最低要求版本：

node -v

你应该看到一个大于 Node 8 的版本。

node -v
v8.15.1

安装 Yarn（可选）

我们强烈建议你安装 Yarn，这是一个替代的包管理工具，在管理你的 NPM 依赖时十分高效。 点击 这里查看。

You can still proceed with the tutorial without Yarn.

创建一个Github仓库

  1. Go to https://github.com/ and sign up for an account if you don't already have one.
  2. 点击 "New Repository" 或是访问 https://github.com/new。
  3. 给你的仓库去一个名字，注意不要带有空格。 比如 docusaurus-tutorial。
  4. 继续创建仓库而不添加 .gitignore 或许可协议。

在Github 中创建仓库 {.docImage}

  1. 将你的仓库克隆到你的电脑上。
git clone [email protected]:USERNAME/docusaurus-tutorial.git # SSH
# or
git clone https://github.com/USERNAME/docusaurus-tutorial.git # HTTPS
  1. cd 进入到你刚刚创建的仓库中。

安装 Docusaurus init 初始化命令

Docusaurus 带有命令行工具来帮助您手写一个 Docusaurus 网站与一些示例模板。 让我们一起来安装吧！

  1. 运行以下命令：
npm install --global docusaurus-init

或者你使用的 Yarn：

yarn global add docusaurus-init
Create a New Site →