介绍

一起探索 Docusaurus 5 分钟内.

开始

从 创建一个新网站 开始.

或者 马上体验 Docusaurus 在 docusaurus.new.

必备环境

• Node.js 版本 18.0 及以上:
  • 安装 Node.js 时, 建议勾选所有相关依赖项.

创建一个新网站

创建一个新 Docusaurus 网站，使用 classic 皮肤模板.

classic 皮肤模板会自动添加到你的项目中，通过执行命令:

npm init docusaurus@latest my-website classic

你可以在命令提示符、PowerShell、终端或你代码编辑器的任何其他集成终端中输入这条命令。

该命令会安装 Docusaurus 运行所需的所有依赖项。

启动你的网站

运行开发服务器:

cd my-website
npm run start

cd 命令可更改你正在使用的目录。为了使用你新创建的 Docusaurus 网站，你需要在终端中将路径切换到该网站所在的目录。

npm run start 命令会在本地构建你的网站，并通过一个开发服务器提供服务，这样你就可以通过 http://localhost:3000 访问该网站了。

打开 docs/intro.md（此页面）并编辑其中几行内容并保存：网站会自动重新加载并显示出你所做的更改。