Skip to content

快速开始 ​

本页说明如何阅读本站文档,以及维护者如何更新内容。

面向读者 ​

文档分为两大类,按需进入:

类别内容入口
指南概念解释、上手路径、最佳实践指南
产品文档单个产品的功能、参数、FAQ产品文档

顶部搜索框支持全文检索,右上角可切换 中文 / English / ไทย。

面向维护者 ​

所有内容都是仓库中的 Markdown 文件,没有独立的后台系统。三种更新方式:

bash
git clone https://github.com/FridaF-SI/WAND-docs.git
cd moonheart-docs
npm install
npm run docs:dev   # http://localhost:5173 实时预览
bash
git add docs/
git commit -m "docs: 更新产品 A 功能说明"
git push            # EdgeOne Pages 自动构建并发布

第三种方式是直接在 GitHub 网页上点开 .md 文件编辑,保存后同样会触发自动部署。

新增一篇文档 ​

  1. 在 docs/products/ 下创建 your-product.md
  2. 文件开头写 front-matter:
markdown
---
title: 你的产品名
description: 一句话说明,会用于搜索结果和 SEO。
---

# 你的产品名
  1. 在 docs/.vitepress/config.mts 的 sidebar 中加入对应条目
  2. 提交推送

关于多语言

中文文档放在 docs/ 下,英文对应 docs/en/,泰文对应 docs/th/,三者路径结构保持一致。例如 docs/products/product-a.md 的英文版就是 docs/en/products/product-a.md。自动化翻译流程依赖这个约定。

下一步 ​

基于 VitePress 构建 · 部署于腾讯云 EdgeOne Pages