How to write a readme.md file?
Last updated
Was this helpful?
Last updated
Was this helpful?
It is a simple plain text file that contains the basic information of the files and some guides. It is used to write some installation guide or basic documentation inside the project directory. Most popular repository providers like GitHub, Gitlab, and bitbucket are using the readme.md file as a file descriptor.
It is a simple plain text file that contains the basic information of the files and some guides. It is used to write some installation guide or basic documentation inside the project directory. Most popular repository providers like GitHub, Gitlab, and bitbucket are using the readme.md file as a file descriptor.
Markdown is a scripting language that is very lightweight. It is used to format plain text to a respective design. Markdowns are rapidly used in content writing in some blog post websites. It converts some plain text to the desired format in HTML. The simplicity and ease to understand are making the markdown more popular. It takes all the text from the markdown file and converts it to HTML through a markdown app or a compiler.
Markdown is a scripting language that is very lightweight. It is used to format plain text to a respective design. Markdowns are rapidly used in content writing in some blog post websites. It converts some plain text to the desired format in HTML. The simplicity and ease to understand are making the markdown more popular. It takes all the text from the markdown file and converts it to HTML through a markdown app or a compiler.
If you are a beginner at markdown file then this article is for you. I am going to write a readme.md file so that you will have a better understanding of the markdown script.
Here I am using visual studio code IDE for writing markdown files. Below are the steps to create a markdown file in visual studio code.
Step-1: Open visual studio code and goto file > new file
Step-2: Name the file as readme.md or readme.markdown and save the file.
Step-3: Find and click the ‘open preview to the side’ icon.
Step-4: Start writing the script.
For writing headings, you have to add the hash # symbol at the beginning of the line. The number of the hash symbol will increase heading type will change according to that.
markdown headings
You can write up to Heading 6.
If you want to write normal text then write simple text here, no need to add any tags it will automatically convert into text.
You can write simple text in a markdown file
You can add a hyperlink in a markdown file by using the below tag.
[link name](targetURL)
e.g. [Github](https://www.github.com)
You can also write link title (While hovering over the link the title will appear)
[link name](targetURL "Link title")
e.g. [Github](https://www.github.com "Github home")
note: Make sure a single space should be their between targetURL and title)
You can write strong and italic text by appending underscores _ before and ending of the line, for italic text add double star ** before and ending of the line for strong/bold text.
_Italic text here_
If you want to strike through a word or line then add two tilde symbols at the beginning and end of the line.
~~Strikethrough text~~
You can add images in a markdown file by using the below tag.
You can write a table by using the below format of text.
If you want to write quotes the just add a > the symbol at the beginning of the line.
>Your quote looks like this.
You can write code by appending ` the symbol at the beginning and end of the line.
If you want to write a block of code then add ``` at starting and ending of the code.
You can specify your language after the ``` at starting of the line.
You can write an ordered list, unordered list, and mixed list. Please see the below format how to write a list.
If you want to add a horizontal line in the markdown file then simply add --- or ***
Note:
***is for thicker line.
