Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.78 KB

READMEEN.md

File metadata and controls

63 lines (45 loc) · 3.78 KB
Raw

GitHub Release Date crychicdoc

GitHub issue custom search in repo GitHub last commit Total Commits GitHub branch status cc-by-sa-shield GitHub contributors

License

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.

Please include a link to this work when reproducing it: https://docs.mihono.cn

The project/team logo is created by Huan Yue の Yin Yi and is authorized for non-commercial use. Please do not take it for any commercial activities.

Hello

你可以在这里查看中文的README.

This is the source code repository for Cryhic documentation.

I have always believed that the most effective way to foster a creative community is through detailed and engaging documentation. That's why I have planned and maintained this documentation project, to help developers and players have a better development and gaming experience (especially in modded environment).

Directory Structure

- crychicdoc
    - .github/    Auto build scripts
    - .vitepress/
        - config/ Localization configuration files
        - plugins/ Location for mdit plugins
        - theme/ Custom themes and components
        - config.mts Vitepress configuration file
        - index.ts Sidebar configuration file
    - .vscode/ md-snippets
    - docs
        - public Directory for storing static files
        - zh Simplified Chinese content
        - en English content
    - README.md This file
    - .gitignore gitignore file
    - ExtractClassScript.js Please ignore
    - extracted_classes.md Please ignore
    - LICENSE CC BY-SA 4.0

Collaboration

This website uses Vitepress as a static site generator. We recommend using the VSCode editor for development.

  1. Install Node.js
  2. Download and install yarn (Make sure you have the necessary permissions to install yarn. Mac/Linux users should use sudo -s, while Windows users need to run Command Prompt (cmd) or PowerShell as an administrator before running npm install -g yarn).
  3. Clone the repository to your local machine.
  4. Install dependencies by running yarn install in the terminal.
  5. Start the local server by running npm run dev in the terminal. You can preview it in your browser.
  6. For more detailed and specific tutorials, you can refer to this document and the official documentation.

This documentation uses a secure and stable deployment solution that ensures long-term stability and access for players in different regions:

  1. Use github action to build the static files of the website and upload them to a private repository, then forward them to a physical server.
  2. Use Aliyun Cloud's GeoDNS to distribute traffic between domestic and international visitors. When international players access the website, the data will be automatically accelerated by CloudFlare.

The domain name is purchased from Aliyun Cloud.