跳到主要内容
版本:8.0(不稳定版)

介绍

让我们在 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(也就是本页)并修改几行内容:网站会自动重新加载并显示你的改动。