文档编写规范

🌱 初步完成

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

合作

具体步骤

• 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设置
    • snippets Markdown代码片段
  • docs 内容目录
    • public 静态资源
    • zh 中文内容
      • 各种文件 文档文件
    • en 英文内容
      • 各种文件 文档文件
  • README.md 项目说明
  • LICENSE CC BY-SA 4.0
  • .gitignore Git忽略规则

编写规范

核心指南文档：

• - Markdown扩展与自定义组件。
• - 配置和管理侧边栏。

辅助工具指南：

• - 创建优雅的树形结构
• - 提高文档编写效率。

Frontmatter配置

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

标题与锚点