文档编写规范

🌱 初步完成

本文档内容已初步完成，可作为参考。但可能存在错误或需要改进的地方。

相关页面

文档	说明
	说明 CrychicDoc 侧边栏的生成方式，以及新增目录和页面时需要调整的字段。
	CrychicDoc 中所有可用的 Markdown 扩展、容器和自定义组件的全面指南。
	在 VitePress 中使用 LiteTree 创建优雅、信息丰富的树形结构的完整指南。
	CrychicDoc 中配置、运行时、组件、插件与样式分别该放在哪里。
	如何在 CrychicDoc 中扩展 Hero 排版、浮动元素、Shader、背景渲染器与导航搜索视觉。
	面向组件扩展、i18n、导航布局、浮动元素与 Markdown 插件的维护规范。

外部参考

链接	定位
	官方框架文档 / Official framework docs

合作

具体步骤

• 1. Fork & Clone
  • 将主仓库 Fork 到您的账户，然后 Clone 到本地。
• 2. 同步与创建分支
  • 在开始修改前，与主仓库同步，然后为您的修改创建一个新分支。
• 3. 修改与提交
  • 在您的新分支上进行修改，并使用清晰的提交信息进行 Commit。
• 4. 发起 Pull Request
  • 将您的分支推送到您 Fork 的仓库，并创建一个 Pull Request 到主仓库。

项目结构

• CrychicDoc 主项目
  • .github CI/CD脚本
    • workflows 自动构建脚本
  • .vitepress VitePress配置
    • config 项目所有配置
      • lang 多语言配置
      • locale 本地化配置
        • langcode 语言对应的配置
          • componennts 组件翻译键
          • snippets 主页漂浮文字翻译键
          • footer.ts footer配置
      • sidebar 侧边栏配置
      • common-config.ts VitePress配置
      • contributors.json 贡献者配置
      • markdown-plugins.ts md插件配置
      • project-config.ts 项目主配置
    • plugins 自定义插件
    • theme 自定义主题
      • components Vue组件
      • styles CSS样式
    • config.mts VitePress配置
    • index.ts 侧边栏配置
  • .vscode VS Code工作区设置
    • settings.json 编辑器工作区设置
    • launch.json 调试配置
  • docs 内容目录
    • public 静态资源
    • zh 中文内容
      • 各种文件 文档文件
    • en 英文内容
      • 各种文件 文档文件
  • README.md 项目说明
  • LICENSE CC BY-SA 4.0
  • .gitignore Git忽略规则

编写规范

核心指南文档：

• - Markdown 扩展与自定义组件。
• - 侧边栏生成方式，以及目录级字段的写法。

辅助工具指南：

• - 创建优雅的树形结构

Frontmatter配置

每个 Markdown 文件都应包含一个 frontmatter 块，用于配置页面的元数据：

Metadata 模式示例

---
metadata:
  mode: kubejs
  current:
    label: 1.20.1
    value: kubejs-2001.6.5-build.7
  requiredMods:
    - name: ProbeJS
      version: probejs-6.0.1
  routes:
    - server_scripts
---

---
metadata:
  mode: modding
  current:
    label: 1.20.4
    value: NeoForge 20.4.x
  stack:
    - name: NeoGradle
      version: userdev 7.0.124
  routes:
    - datagen
    - registry
---

---
metadata:
  mode: mod
  side: both
  latest: 1.21.x
  supported: [1.21.x, 1.20.1, 1.19.2, 1.18.2]
  loaders: [Forge, NeoForge]
  sources:
    curseforge: https://www.curseforge.com/minecraft/mc-mods/example
    modrinth: https://modrinth.com/mod/example
---

当 metadata.mode: mod 时，side 可写为 server、client 或 both。

目录级元数据通常写在 sidebarIndex.md 中；当目录本身需要可点击的落地页时，系统会按 index.md -> Catalogue.md -> README.md 的顺序寻找页面。

标题与锚点