Jump to content

Markdown: Difference between revisions

From Bath Wiki
Translate from boss.bathcs.com
 
No longer written in markdown.
Line 1: Line 1:
This is not a programming language, but all READMEs should be written in markdown, and this whole wiki is.
This is not a programming language, but all READMEs should be written in markdown.


<ul>
<ul>

Revision as of 22:46, 11 June 2026

This is not a programming language, but all READMEs should be written in markdown.

  • Tab size to 2 spaces

  • Use - over *

  • Max line length should be 80

  • Use blank lines to space things out!

    ## A title
    
    Some text
    
    - point1
    - point2
  • Code blocks should always have a filetype

    ```py
    print("Hi")
    ```
  • Anything relating to the point above should be indented and blank space left

    - point1
    
      some other paragraph
    
    - point2

Formatters do exist (e.g. prettier or biome) so use them please!