教程简介

让我们用不到 5 分钟认识 Docusaurus。

快速开始

从创建一个新站点开始。

或者用 docusaurus.new 立即体验 Docusaurus。

你需要准备

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

生成新站点

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

运行下面的命令后，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（本页）并编辑几行：站点会自动重新加载并显示你的更改。