Skip to content

Instantly share code, notes, and snippets.

@kushalseth
Created September 6, 2020 08:26
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save kushalseth/1b966e9542ba56bb0f4e983e0553987f to your computer and use it in GitHub Desktop.
Save kushalseth/1b966e9542ba56bb0f4e983e0553987f to your computer and use it in GitHub Desktop.
## Resources to build good Readme.md
- If you liked the template, you can fork https://github.com/kushalseth/kushalseth
- Few links I usually use for md file fomatting
- General Formatting [https://shields.io/](https://shields.io/)
- Emojis in ReadMe: [EmoJI](https://www.webfx.com/tools/emoji-cheat-sheet/)
- Editor Editor: [https://stackedit.io/app#](https://stackedit.io/app#)
- Warnings: https://stackoverflow.com/questions/50544499/how-to-make-a-styled-markdown-admonition-box-in-a-github-gist
- Adding colors to the MD file text:
- https://stackoverflow.com/questions/23904274/is-there-a-way-to-get-colored-text-in-github-flavored-markdown/41043795
- https://stackoverflow.com/questions/35465557/how-to-apply-color-in-markdown?rq=1
- https://stackoverflow.com/questions/11509830/how-to-add-color-to-githubs-readme-md-file
- Basic MD formatting: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
- GitHub Writing Official link: [writing tips](https://docs.github.com/en/github/writing-on-github)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment