跳到主要内容

教程介绍

让我们在 5 分钟内了解 Docusaurus

开始使用

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

或者 立即试用 Docusaurus,访问 docusaurus.new

你需要什么

  • 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(本页面)并编辑一些行:网站会 自动重新加载 并显示你的更改。