跳到主要内容

教程简介

让我们在不到 5 分钟内发现 Docusaurus

入门

开始创建一个新网站

立即尝试 Docusaurus,使用 docusaurus.new

您需要什么

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