跳到主要内容

教程介绍

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