This project is a Github sample warehouse template, the main content is the sample template of README file.

Website Link

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

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:

[![Readme file conforming to Yakia](https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat.svg)](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 Yakia"
    src="https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat.svg"
  />
</a>

Please modify the file name yourself to get the style you want:

File Nmae	Style Preview
badge_flat.svg
badge_flat-square.svg
badge_for-the-badge.svg
badge_plastic.svg
badge_social.svg

Thanks to the maintainers of these projects:

Thank you to all the contributors who participated in the development of yakia. Contributors

• Tigago - High performance lightweight web framework
• Wails Template Vue - A wails template based on Vue and Vue-Router
• Awesome Wails - A carefully selected list of Wails applications
• Static Theme Misipage - Static Homepage Theme

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.

License MIT