Jump to content

Markdown: Difference between revisions

From Bath Wiki
No longer written in markdown.
cat
Line 24: Line 24:


Formatters do exist (e.g. [https://prettier.io/ prettier] or [https://biomejs.dev/ biome]) so use them please!
Formatters do exist (e.g. [https://prettier.io/ prettier] or [https://biomejs.dev/ biome]) so use them please!
[[Category:Bath Open Source Society]]
[[Category:Programming language guidelines]]

Revision as of 06:56, 26 August 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!