跳到主要内容

入门指南

完整的 My Docs 使用指南。

第一步：项目设置​

1. 创建新文档项目​

npx create-docusaurus@latest my-docs classic
cd my-docs

2. 安装依赖​

npm install

3. 启动开发服务器​

npm run dev

第二步：内容编写​

创建新文档​

在 docs 目录下创建 Markdown 文件：

# 我的文档标题

这是我的文档内容。

## 子标题

更多内容...

配置侧边栏​

编辑 sidebars.js 文件：

module.exports = {
  mySidebar: [
    'intro',
    {
      type: 'category',
      label: '指南',
      items: ['guides/getting-started', 'guides/advanced'],
    },
  ],
};

第三步：自定义样式​

修改主题颜色​

在 docusaurus.config.js 中：

themeConfig: {
  colorMode: {
    defaultMode: 'light',
    respectPrefersColorScheme: true,
  },
}

添加自定义 CSS​

在 src/css/custom.css 中：

:root {
  --ifm-color-primary: #your-color;
}

第四步：部署​

GitHub Pages​

  1. 在 GitHub 创建仓库
  2. 推送代码
  3. 在仓库设置中启用 GitHub Pages

Vercel​

npm i -g vercel
vercel

最佳实践​

文档结构​

  • 使用清晰的目录结构
  • 保持文件名简洁
  • 使用一致的命名约定

内容质量​

  • 编写清晰的介绍
  • 提供代码示例
  • 包含截图和图表
  • 添加相关链接