Skip to content

misitebao/yakia

Repository files navigation

Yakia

Yakia is a developer helper.

GitHub GitHub CodeFactor Go Report Card Discord
GitHub tag (latest SemVer pre-release) npm Crates.io

Table of Contents

Click me to Open/Close the directory listing

Introductions

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

Official Website

Website Link

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.

Readme file conforming to Yakia

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 Readme file conforming to Yakia
badge_flat-square.svg Readme file conforming to Yakia
badge_for-the-badge.svg Readme file conforming to Yakia
badge_plastic.svg Readme file conforming to Yakia
badge_social.svg Readme file conforming to Yakia

Maintainer

Thanks to the maintainers of these projects:

misitebao
Click me to Open/Close the maintainer listing

Contributors

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

eighteenzheng

Part Of Users

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

License MIT

FOSSA Status