Get Even More Visitors To Your Blog, Upgrade To A Business Listing >>

Tips to write a beautiful and useful README.md file


  • Title and subtitles:
    • Title starts with #
    • Subtitle starts with ##
    • SubSubTitle starts with ###
    • SubSubSub...N starts with {#}n
 # Title  
Explain

## Sub Title
This is other content related to Title

### Sub Title
This is a content related to Sub Title

## SubSubTitle
This is other content related to Title

  • Show a beautiful Json content use "```json" and the begining and  "```" at the end:
 ```json  
{
something:'Yeah',
other:'Oh Yeah!',
}
```
  • If you put 4 spaces behind the content it will be showed in a separated box.
  • For multiple items use '-', '*' or '.' at the begining of the lines.
 - This is the first one  
- This is the second one
  • Use '`' to open and close a grey rectangle over a variable, path or something you want to show. If you write`PATH_IMAGES`... will be draw something like:
 PATH_IMAGES


This post first appeared on Makingiants, please read the originial post: here

Share the post

Tips to write a beautiful and useful README.md file

×

Subscribe to Makingiants

Get updates delivered right to your inbox!

Thank you for your subscription

×