This is a simplified outline of a few tips that can be added to a git README.md markdown to spice up your documentation.
Uploading a picture is very simple. Just copy and paste. This works with png, jpg, and jpeg files.
The colors relay different messages
On how to add badges check this detailed blog for a step to step guide.
For more badges check shields.io
Nested dropdown lists are made with the details html tag. By defaul the details tag is closed
Click to open
Hello World!<details><summary>Click to open</summary>
Hello World!
</details>
But can be made open using the open attribute
Click to close
You left me open...<details open><summary>Click to close</summary>
You left me open...
</details>
Git markdown does not have support for inline CSS so the font-awesome icons themselves can't be used. However, there is a way to work around that:
- First download or get a pic of the icon. It should be in a png, jpg, or jpeg format.
- Upload the picture to the markdown. The link should be placed in a pair of square brackets []
- Add the link to your site in round brackets
[](link-to-site)
[](https://dev.to/babib)
[](https://twitter.com/BTweets47)
Contributions are always welcome! Please read the contribution guidelines first.
I have written a detailed blog on how each tip mentioned here can be implemented.
Babi 💞