跳到主要内容

快速开始

本指南帮助你在几分钟内完成安装与上手。

环境要求

  • Node.js 20.0 或更高版本
  • 包管理器:npm / pnpm / yarn 任选其一

安装

# 进入项目目录
cd my-doc-site

# 安装依赖
npm install

本地启动

# 启动开发服务器(默认简体中文)
npm start

启动后浏览器访问 http://localhost:3001 即可预览。

构建与部署

# 构建生产版本(包含全部语言)
npm run build

# 本地预览构建结果
npm run serve

构建产物位于 build/ 目录,可部署到任意静态托管服务(GitHub Pages、Vercel、Netlify 等)。

常见问题

Q:如何切换默认语言? A:编辑 docusaurus.config.ts 中的 i18n.defaultLocale 字段。

Q:如何新增一篇文档? A:在 docs/ 目录下新建 .md 文件,并在文件顶部填写 titlesidebar_position