跳到主要内容

入门导览

一起探索 在 5 分钟内了解 Docusaurus.

开始使用

开始创建 一个新站点.

Or 立即体验 Docusaurus with docusaurus.new.

你需要准备

  • Node.js 20.0 或更高版本:
    • 安装 Node.js 时,建议勾选所有与依赖相关的选项。

生成新站点

使用以下命令生成一个新的 Docusaurus 站点: 经典模板.

运行以下命令后,经典模板将自动添加到你的项目中:

npm init docusaurus@latest my-website classic

你可以在命令提示符、PowerShell、终端或任何代码编辑器的集成终端中输入此命令。

该命令还会安装运行 Docusaurus 所需的所有必要依赖。

启动站点

运行开发服务器:

cd my-website
npm run start

The cd 命令会切换你当前的工作目录。要使用新创建的 Docusaurus 站点,你需要在终端中导航到该目录。

The npm run start 命令会在本地构建你的网站,并通过开发服务器提供服务,你可以在以下地址查看: http://localhost:3000/.

Open docs/intro.md (本页面)并编辑几行内容:站点 会自动重新加载 并显示你的更改。