In my previous post, I listed and juxtaposed what the content of an efficient readme file should be. In this write up, I'll be giving you guides on how to write your readme file with markdown semantics. Markdown is very similar to text with some syntax written for bold, italic, links etc.
So let’s head on with some guides:
Headers
Headers are written in markdown language with the use of the hash tag. Just like the hypertext mark up language (HTML), the number of hash tags used indicates the header tag's font size and boldness. Note that there should be a space between the hash tags and the text to be displayed.
# This is a <h1> tag.
## This is a <h2> tag.
###### This is a <h6> tag.
Emphasis
The star (*) sign is used for emphasis in markdown language and a double star (**) would make the text bold.
*This text will be italic* This text will be italic
**This text will be bold** This will also be bold
Linking Images
Images are added with the format below:
Adding Links
Links are added with the format below:
*link to be seen.com*! [alt](url)
Username Mentions
If there is a need to mention someone who contributed in any format to the project or reported an issue, then you can easily mention that person using the ‘@’ symbol followed by the name.
Strikethrough
Any text or word wrapped in ~~word~~ will appear as crossed out.
Emoji
We can also add some emojis to our markdown files. Some common emojis are as follows:
1 :grinning: 😀
2 :smiley: 😃
3 :laughing: or :satisfied: 😆
4 :sweat_smile: 😅
5 :rofl: 🤣
6 :joy: 😂
7 :slightly_smiling_faces: 🙂
8 :upside_down_face: 🙃
9 :blush: 😊
10 :innocent: 😇
Task Lists
The format for adding lists like checkboxes is shown below:
– [x] This is a complete item
[ ] This is an incomplete item
This is a brief summary of the major syntax you need to master if you want to write a professional readme file. Look forward to my next post as I'll be explaining why it is necessary to have a readme file attached to your project.
Was this helpful in anyway??? Don't hesitate to like and share... 😊 😊 You can reach out to me on twitter @princessmaggy7. 😊