As a software developer or technical writer, you know the importance of a well-formatted Readme file.
A clear and concise Readme file can help others understand your project more easily and improve its visibility.
One important aspect of formatting a Readme file is indenting bulleted lists.
In this tutorial, we will show you how to indent a bulleted list in a Readme file using Github Flavored Markdown (GFM).
What is Github Flavored Markdown?
GFM is a variant of the Markdown language that is used to format text and documentation in Github repositories.
It extends the standard Markdown syntax with additional features such as syntax highlighting, task lists, tables, and more.
How to Indent a Bulleted List in GFM
GFM allows you to indent a bulleted list by adding spaces before the start of each line. The number of spaces you add determines the level of indentation.
Here’s an example:
- First level bullet
- Second level bullet
- Third level bullet
In the example above, the second level bullet is indented two spaces, and the third level bullet is indented four spaces.
Tips for Indenting Bulleted Lists in GFM
- Make sure to add spaces before the start of each line, not after.
- To keep your code consistent, it’s a good idea to use the same number of spaces for each level of indentation. For example, you could use two spaces for each level.
- If you’re using a text editor that automatically indents code, be careful when indenting your bulleted list. Some editors may add extra spaces that you don’t want.
Conclusion
Indenting bulleted lists in a Readme file using Github Flavored Markdown is a simple process.
By adding spaces before the start of each line, you can create nested bullet points and make your documentation more organized and readable.
By following the tips outlined in this article, you can ensure that your bulleted lists are properly indented and formatted.
