Markdown
programming
language
This is a Markup Language that is widely used, for example it is used in GitHub README pages and Obsidian notes. It has a fairly basic syntax, that I am going to have great fun describing in a Markdown file.
Syntax I am sure there is more, but this is what I have found useful so far!
| Format | Syntax | Example |
|---|---|---|
| Headings | # at the beginning of the line up to 6 characters. | ## Title |
| Italic | * or _ wrapped around the statement | *Italic* |
| Bold | ** or __ wrapped around the statement | **Bold** |
| Italic and Bold | *** or ___ wrapped around the statement | ***Statement*** |
| Strike through | ~~ wrapped around the statement | ~~statement~~ |
| Back quotes | > at the begining of the line, can be contined over multiple | > important quote |
| lists | -, * or + at the beginning of the line | - item |
| Numbered lists | 1., 7. a number then a dot at the start of the line1 | 1. item |
| Code blocks | Put the code in `` | ``Like this`` |
| Links | Single square brackets on the linked text and then link in normal brackets | [test](link) |
| Images/recall | Put an ! before the square brackets to render the image or preview text |  |
| Horizontal line | Use ___, --- or *** on an open line | ___ |
| Adding titles | In links to can add text in quotes in the link to make that a title | [test](link “This link”) |
| Escape Characters | The \ allows you to put characters in text that have special meanings | \*test\* |
| Tables | Tables use | and --- to separate columns and rows | | title1 | title2|\n|---|---|2 |
| Alignment in tables | This can be done using : on the side of the --- you want to align to | | title1 | title2|\n|:---|:---:|3 |
| Syntax highlighting | Sometimes it can highlight syntax if it knows it using ``` followed by the language | ```json { “hi”: “bye”}``` |
| Text highlighting | == wrapped around the statement | ==test== |
| Footnotes | [^text] at the point you want the foot note and [^text]: where you want the text | text[^1] … [^1]: This is a foot note |
| Tasks | Use unordered lists but put [ ] after it or [x] to mark it done | - [ ] or - [x] |