教程介绍

让我们在 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（本页面）并编辑一些内容：网站将 自动重新加载 并显示您的更改。