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:

Titles and Anchors