教程介绍

让我们在 5 分钟内了解 Docusaurus。

开始使用

通过 创建新站点 开始使用。

或者通过 docusaurus.new 立即试用 Docusaurus。

你需要什么

• Node.js 版本 18.0 或以上：
  • 安装 Node.js 时，建议勾选所有与依赖项相关的复选框。

生成新站点

使用 经典模板 生成新的 Docusaurus 站点。

运行命令后，经典模板将自动添加到你的项目中：

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（此页面）并编辑一些行：站点会 自动重新加载 并显示你的更改。