Code, quotes and tables

The parts a README actually needs.

Code in the middle of a sentence goes in single backticks, so it reads as code rather than prose.

A block of code goes in a fence: three backticks, the language, your code, three backticks again. Naming the language is what gets it coloured.

A quote is a > at the start of the line:

Programs must be written for people to read.

A table is pipes and a row of dashes under the header:

| Command | What it does |
|---|---|
| `build` | Compiles it |
| `start` | Runs it |

The dashes row is what makes it a table rather than three lines with pipes in them. Alignment is optional: :--- left, ---: right, :---: centred.

Try it

The playground has a README with all four. Add a row to the table, change a fence's language from js to html, and see what colouring does and does not change.

Loading...