Installation
Docusaurus 的设计理念,最一开始就是要易于安装和使用,让你的网站可以快速架好并运行起来。
- 安装 Docusaurus
我们创建了一个简单的脚本, 它将获得为您设置的所有基础结构:
+我们为你归纳了一个简单的操作流程,它包括了建立 Docusaurus 站点基础架构需要执行的所有操作:
确保你已经安装了最新版的 Node。 此外我们建议你再装个 Yarn。
-
您必须有 Node > = 8. x 与 Yarn > = 1.5。
+Node 版本应不低于 8.x,Yarn 版本应不低于 1.5。
-Create a project, if none exists, and change your directory to this project's root.
-文档会被创建在此目录下。 根目录可能会包含其他文件。 Docusaurus的安装脚本会创建两个新目录:
+docs
和website
。如果没有已经创建好的 Docusaurus 项目,则新建一个目录作为新项目的根目录,然后进入其中。
+你将在这个目录中创建文档。 根目录可能会包含其他文件。 Docusaurus 安装脚本会创建两个新的目录:
docs
和website
。-
通常,Docusaurus 站点的位置会是现有或新创建的 GitHub 项目。但这不是 Docusaurus 的强制要求。
+一般来说,把 Docusaurus 站点文件,存放在已有的或新建的 GitHub 项目目录下,是个不错的选择,不过 Docusaurus 并不强制要求你这样做。
-运行 Docusaurus 的安装脚本:
+npx docusaurus-init
。运行 Docusaurus 安装脚本:
npx docusaurus-init
。-
如果您没有安装 Node 8.2 + ,或是您希望在全局范围内安装 Docusaurus,请运行
+yarn global add docusaurus-init
或npm install --global docusaurus-init
。 安装完成后,运行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:
+加上前面提到的几个文件和目录,现在你的 Docusaurus 项目的目录结构应该看起来像这个样子:
root-directory
├── Dockerfile
├── README.md
@@ -126,22 +126,22 @@
└── static
- 运行示例网站
根据 Installation 部分所述运行 Docusaurus 的初始化脚本 docusaurus-init
后,你将会有一个可运行的示例网站。 要运行这个示例:
在执行完安装 Docusaurus 一节中提到的 Docusaurus 初始化脚本docusaurus-init
之后,你会得到一个能够正常运行的示例网站,你可以基于它来建设自己的站点。 要运行这个示例:
cd website
-在
website
目录下,启动Docusaurus服务器:yarn start
或npm start
。
-如果没有自动打开已启动的示例网站,请从 http://localhost:3000 访问示例站点。 如果 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. Docusaurus将会自动选取一个随机生成的主要和次要主题颜色。
+在
website
目录下,启动 Docusaurus 本地服务器,通过执行命令yarn start
或npm start
。
+如果示例站点没有自动打开,可以从 http://localhost:3000 访问它。 如果 3000 端口已被占用,将使用另一个端口。 查看控制台消息以确认使用了哪个端口。
+现在,你应该已经看到了浏览器中加载的示例站点。 与此同时,还有一个 LiveReload 服务也在运行,你对
website
目录中的文档和文件进行任何更改,都将实时刷新网页内容。 Docusaurus 会为你的网站随机生成一种主色和辅色。
- 使用代理启动服务
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.
+ 使用代理软件后启动本地服务器
如果你使用了代理软件,那么你需要先禁用它,这样你对本地开发服务器的请求才能正常生效。 这可以通过使用 NO_PROXY
环境变量来完成。
SET NO_PROXY=localhost
-yarn start (or npm run start)
+yarn start (或 npm run start)
-- Updating Your Docusaurus Version
在 Docusaurus 安装之后,你可以在 website
目录下查看最新版本,或是输入 yarn outdated docusaurus
或 npm outdated docusaurus
查看。
You will see something like this:
++ 更新你的 Docusaurus 版本
安装好 Docusaurus 之后,你可以查看当前 Docusaurus 的版本号,通过在 website
目录下执行命令 yarn outdated docusaurus
或者 npm outdated docusaurus
。
你会看到类似这样的输出结果:
$ yarn outdated
Using globally installed version of Yarn
yarn outdated v1.5.1
@@ -156,18 +156,18 @@ docusaurus 1.0.9 1.2.0 1.2.0 devDependencies https://github.com/facebook/doc
✨ Done in 0.41s.
--如果
+outdated
命令没有任何版本过期的通知,那你就处于最新版本。如果执行
outdated
命令后,输出结果中没有重要版本更新提示,就意味着你正在使用的是最新版本。
You can update to the latest version of Docusaurus by:
+你可以将 Docusaurus 更新到最新版本,通过执行命令:
yarn upgrade docusaurus --latest
或
npm update docusaurus
--如果你在升级后发现任何错误,请尝试清除你的 Babel 缓存。通常在 temporary directory,或是在
+BABEL_DISABLE_CACHE=1
的配置下运行 Docusaurus 服务(如:yarn start
)。如果在升级之后你遇到了某些错误,可以试着清空你的 Babel 缓存(通常位于临时目录),或试着在设置了
BABEL_DISABLE_CACHE=1
的情况下启动 Docusaurus 服务器(例如,通过执行命令yarn start
)。