Awesome
<div align="center"> <a href="https://yakia.misitebao.com/"> <img src="assets/logo.gif" width="200" height="200" /> </a> <h1>Yakia</h1> <p> Yakia is a developer helper. </p> <p> <a href="https://github.com/misitebao/yakia/blob/main/LICENSE"> <img alt="GitHub" src="https://img.shields.io/github/license/misitebao/yakia"/> </a> <a href="https://github.com/misitebao/yakia"> <img alt="GitHub" src="https://cdn.jsdelivr.net/gh/misitebao/yakia/assets/badge_flat.svg"/> </a> <a href="https://www.codefactor.io/repository/github/misitebao/yakia"> <img src="https://www.codefactor.io/repository/github/misitebao/yakia/badge" alt="CodeFactor" /> </a> <a href="https://goreportcard.com/report/github.com/misitebao/yakia"> <img src="https://goreportcard.com/badge/github.com/misitebao/yakia" alt="Go Report Card"/> </a> <a href="https://discord.gg/zRC5BfDhEu"> <img alt="Discord" src="https://img.shields.io/discord/1044100035140390952"> </a> <br/> <a href="https://pkg.go.dev/github.com/misitebao/yakia/cmd/yakia"> <img alt="GitHub tag (latest SemVer pre-release)" src="https://img.shields.io/github/v/tag/misitebao/yakia?include_prereleases&label=pkg.go.dev"/> </a> <a href="https://www.npmjs.com/package/yakia"> <img alt="npm" src="https://img.shields.io/npm/v/yakia"/> </a> <a href="https://crates.io/crates/yakia"> <img alt="Crates.io" src="https://img.shields.io/crates/v/yakia"/> </a> </p> <!-- <p> <a href="#">Installation</a> | <a href="#">Documentation</a> | <a href="#">Twitter</a> | <a href="https://discord.gg/zRC5BfDhEu">Discord</a> </p> --> <div> <strong> <samp> </samp> </strong> </div> </div>Table of Contents
<details> <summary>Click me to Open/Close the directory listing</summary>- Table of Contents
- Introductions
- Graphic Demo
- Features
- Architecture
- Getting Started
- Maintainer
- Contributors
- Community Exchange
- Part Of Users
- Changelog
- Donators
- Sponsors
- Special Thanks
- License
Introductions
This project is a Github sample warehouse template, the main content is the sample template of README file.
Official Website
Background
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.
Features
- 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
Getting Started
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 |
Maintainer
Thanks to the maintainers of these projects:
<a href="https://github.com/misitebao"> <img src="https://github.com/misitebao.png" width="40" height="40" alt="misitebao" title="misitebao"/> </a> <details> <summary>Click me to Open/Close the maintainer listing</summary>- Misitebao - Maintainer of Yakia.
Contributors
Thank you to all the contributors who participated in the development of yakia. Contributors
<a href="https://github.com/eighteenzheng"> <img src="https://github.com/eighteenzheng.png" width="40" height="40" alt="eighteenzheng" title="eighteenzheng"/> </a>Part Of Users
- 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.