Skip to content

Instantly share code, notes, and snippets.

@milkbread
Last active July 24, 2022 22:16
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save milkbread/5795012 to your computer and use it in GitHub Desktop.
Save milkbread/5795012 to your computer and use it in GitHub Desktop.
MD: Readme.md styling test

How to structure a readme file

Tutorial and cheat sheet in one file!

Headings are indicated by one or more #hashtags, while...

... it is getting smaller, and smaller...

Add a line by just adding 3 hyphens


This is a basic text, without any indenting or highlighting!

  • Indenting ... One *star or -hyphen, at the beginning of a line, makes an indenting of 1st order

    • when followed by another single * or - you've got the 2nd order
      • and the 3rd order
        • and so on...
  • Highlighting ... Surround a word with:

    • italic: 1 *star
    • bold: 2 *stars
    • bold-italic: 3 *stars
  • Links ... are simply added this way:

  • Code ... is indicated with `apostrophs and can be described by a language prefix:

    • 1 apostroph, no prefix --> display content in a -one line- box, without any syntax highlighting

    var test = {key:'value'}; alert (test.key)

    • 3 apostrophs, language prefix --> display code in a -multi line- box, with syntax highlighting
     var test = {key:'value'};
     alert (test.key)

What should be described in a readme.md file?!

There is also a ! ... what can I do with it?

Link to an image!

...cool we can add images by the !note of exlamation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment