Skip to content

本地使用 ​

技术文档直接读取仓库现有 Markdown,不建立额外内容副本,也不维护第二套正文。现有文件和链接保持不变;网站配置位于 src/.vitepress/,正文统一放在 doc/。

命令 ​

使用 Node.js 22 或更高版本,在 maodo-wiki 根目录执行:

sh
npm ci
npm run docs:dev

开发地址以终端输出为准,默认只监听本机。搜索支持快捷键 Ctrl/Cmd + K;右侧显示二、三级标题;外观按钮切换深色模式。

sh
npm run docs:check
npm run docs:build
npm run docs:preview

构建产物为 dist/,不提交 Git。子路径托管时,在构建时设置 DOCS_BASE=/maodo-wiki/;域名根目录保持默认 /。

图表 ​

直接在 Markdown 写 Mermaid 代码块。下图说明文档更新流程,不代表业务运行架构。

flowchart LR
  A[源码提交差异] --> B[影响候选文档]
  B --> C[核实具体章节]
  C --> D[修改受影响段落]
  D --> E[链接检查与构建]
  E --> F[审阅并提交 wiki]