教程介绍

让我们在不到5分钟的时间内了解 Docusaurus。

开始使用

通过创建一个新站点开始。

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

你需要准备什么

• Node.js 版本 20.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（本页面）并编辑几行：网站将自动重新加载并显示您的更改。