Click me to Open/Close the directory listing
This project is a Github sample warehouse template, the main content is the sample template of README file.
When searching for the required tools and libraries in the open source community, I found that there are many excellent code libraries, but there is no good README file or tutorial, which causes users to spend extra time to learn how to use it, so this project provides A standard code base template, hoping to help others.
- The project logo and corresponding data are displayed in the center
- Provide multi-language functions and sample templates
- README must-have instructions
- Built-in directory navigation function to solve the problem that some Markdown parsing engines cannot parse navigation correctly
|—— .gitee Gitee Configuration File
| |—— ISSUE_TEMPLATE.md Gitee Issue Template
| |—— PULL_REQUEST_TEMPLATE.md Gitee PR Template
|—— .github Github Configuration File
| |—— ISSUE_TEMPLATE Github Issue Template
| | |—— issue-template-bug.md Github Issue Bug Template
| | |—— issue-template-feature.md Github Issue Feature Template
| |—— workflows Github Workflows
| | |—— deploy-for-hugo.yml Github Workflows Hugo Example
| | |—— deploy-for-nodejs.yml Github Workflows NodeJS Example
| |—— pull-request-template.md Github PR Template
|—— website Project website
|—— CHANGELOG.md Release Log
|—— LICENSE LICENSE
|—— README.md English README
|—— README.zh-Hans.md Other Language README
|—— README.tmpl.md README Template
If your README conforms to the yakia, you can add a badge to link back to this specification to help others adopt this readme.
To add in markdown format, please use the following code:
[](https://github.com/misitebao/yakia)To add in HTML format, please use the following code:
<a href="https://github.com/misitebao/yakia">
<img
alt="GitHub"
src="https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat-square.svg"
/>
</a>Please modify the file name yourself to get the style you want:
| File Nmae | Style Preview |
|---|---|
| badge_flat-square.svg | |
| badge_flat.svg |  |
| badge_for-the-badge.svg |  |
| badge_plastic.svg |  |
| badge_social.svg |  |
Thanks to the maintainers of these projects:
Click me to Open/Close the maintainer listing
- Misitebao - Project author, full stack engineer.
Thank you to all the contributors who participated in the development of yakia. Contributors
- Gitter - A public instant chat tool.
- Tigago - A modular framework based on Go language
- wails-template-vue - A wails template based on Vue and Vue-Router
If your project uses this specification, you can fork this project and submit a PR to add your project to this list, so that others can know your project.