文档编辑指南

MoFox-Bot-Docs 是 Neo-MoFox 的官方文档站点，基于 VitePress 构建。本章节面向所有希望为文档贡献内容的写作者——无论你是修正一个错别字，还是新增一整章指南，都可以在这里找到完整的本地编辑流程。

章节导航

1. 安装 Node.js 环境 — 在你的电脑上准备好运行 VitePress 所需的运行时。
2. 编辑文档内容 — 了解仓库结构、Markdown 语法约定与 VitePress 扩展写法。
3. 启动与预览 — 本地启动开发服务器、构建与预览生产产物。
4. 侧边栏与顶栏配置 — 在 config.ts 中为新页面添加导航入口。

写作约定

• 语言：正文使用简体中文，标点使用全角符号（，。：；！？），代码与命令保持半角。
• 文件名：使用小写英文 + 连字符命名（如 nodejs-install.md），避免空格与中文文件名。
• 链接：站内链接使用相对路径并省略 .md 扩展名（如 [安装](./nodejs-install)）。
• 代码块：所有代码块必须标注语言（bash、ts、md 等），便于语法高亮。
• 标题层级：一级标题（#）每页仅一个，作为页面主标题；后续按 ##、### 依次递进。

整体流程速览

安装 Node.js ──► 克隆仓库 ──► 安装依赖 ──► 启动开发服务器
                                                  │
                                                  ▼
                                    编写/修改 Markdown 文件
                                                  │
                                                  ▼
                                    （如需）在 config.ts 添加侧边栏/顶栏项
                                                  │
                                                  ▼
                                        本地预览校验 ──► 提交 PR

接下来请按顺序阅读 安装 Node.js 环境 开始。

贡献者

minecraft1024a

页面历史

最后编辑于 5 天前

查看完整历史

859d421-docs: 添加文档编辑指南及相关章节，增强用户对文档编辑流程的理解