CryChicDoc

English

简体中文

English

简体中文

Switch Theme

Switch Theme

Documentation Writing Standards ​

🌱 初步完成

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

Contribution ​

Specific Steps ​

  • 1. Fork & Clone
    • Fork the main repository to your account, then clone it locally.
  • 2. Sync and Create Branch
    • Before making changes, sync with the main repository, then create a new branch for your modifications.
  • 3. Modify and Commit
    • Make changes on your new branch and commit with clear commit messages.
  • 4. Create Pull Request
    • Push your branch to your forked repository and create a Pull Request to the main repository.

Project Structure ​

  • CrychicDoc Main project
    • .github CI/CD scripts
      • workflows Automated build scripts
    • .vitepress VitePress configuration
      • config All project configurations
        • lang Multi-language configuration
        • locale Localization configuration
          • langcode Language-specific configurations
            • componennts Component translation keys
            • snippets Homepage floating text translation keys
            • footer.ts Footer configuration
        • sidebar Sidebar configuration
        • common-config.ts VitePress configuration
        • contributors.json Contributors configuration
        • markdown-plugins.ts Markdown plugin configuration
        • project-config.ts Main project configuration
      • plugins Custom plugins
      • theme Custom theme
        • components Vue components
        • styles CSS styles
      • config.mts VitePress configuration
      • index.ts Sidebar configuration
    • .vscode VS Code settings
      • snippets Markdown code snippets
    • docs Content directory
      • public Static resources
      • zh Chinese content
        • Various files Documentation files
      • en English content
        • Various files Documentation files
    • README.md Project description
    • LICENSE CC BY-SA 4.0
    • .gitignore Git ignore rules

Writing Standards ​

Core Guide Documents:

  • - Markdown extensions and custom components.
  • - Configure and manage the sidebar.

Auxiliary Tool Guides:

  • - Create elegant tree structures
  • - Improve documentation writing efficiency.

Frontmatter Configuration ​

Each Markdown file should include a frontmatter block to configure page metadata:

Metadata Mode Examples
yaml
---
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
---
yaml
---
metadata:
  mode: modding
  current:
    label: 1.20.4
    value: NeoForge 20.4.x
  stack:
    - name: NeoGradle
      version: userdev 7.0.124
  routes:
    - datagen
    - registry
---
yaml
---
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
---

For metadata.mode: mod, side accepts server, client, or both.

Titles and Anchors ​