Skip to main content

教程

让我们在不到5分钟的时间内了解 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(本页面)并编辑一些行:站点会 自动重新加载 并显示你的更改。