https://github.com/hmcl-dev/hmcl-pe-docs
Documentations of HMCL-PE
https://github.com/hmcl-dev/hmcl-pe-docs
Last synced: 9 months ago
JSON representation
Documentations of HMCL-PE
- Host: GitHub
- URL: https://github.com/hmcl-dev/hmcl-pe-docs
- Owner: HMCL-dev
- Created: 2022-09-25T11:24:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-29T14:47:17.000Z (over 3 years ago)
- Last Synced: 2025-01-21T22:43:13.035Z (over 1 year ago)
- Size: 2.71 MB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HMCL-PE-Docs
Documentations for HMCL-PE
You can submit a Pull Request to this repository to contribute.
## How to contribute
Please place your markdown file at
```
_/.md
```
If your doc contains images, please place your images at
```
assets/img/docs//
```
`` means your article category, such as **launcher**, **modpack**.
`` is your article name.
`` is the image you are using in your article.
### Add new article
Please ensure that the content is stored in the above format.
Not to modify the content of other articles in a PR that adds a new article.
### Modify an existing article
Please make sure that your PR modifies only one article, and attribute in that article.
### Update index.json
Add an object to target category item like this:
```
{
"title": "Example", // Whole title of the passage.
"subtitle": "Example", // Subtitle of the passage.
"author": "Example", // Your name.
"path": "/_/.md" // Path of the passage.
}
```
So we can display the passage on our website.