跳至主要内容

教程简介

让我们在不到 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(此页面)并编辑一些行:网站会自动重新加载并显示您的更改。