Markdown

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!

FormatSyntaxExample
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 lists1., 7. a number then a dot at the start of the line11. item
Code blocksPut the code in ““Like this“
LinksSingle square brackets on the linked text and then link in normal brackets[test](link)
Images/recallPut an ! before the square brackets to render the image or preview text![test](link)
Horizontal lineUse ___, --- or *** on an open line___
Adding titlesIn links to can add text in quotes in the link to make that a title[test](link “This link”)
Escape CharactersThe \ allows you to put characters in text that have special meanings\*test\*
TablesTables use | and --- to separate columns and rows| title1 | title2|\n|---|---|2
Alignment in tablesThis can be done using : on the side of the --- you want to align to| title1 | title2|\n|:---|:---:|3
Syntax highlightingSometimes it can highlight syntax if it knows it using ``` followed by the language```json { “hi”: “bye”}```
Text highlighting== wrapped around the statementtest
Footnotes[^text] at the point you want the foot note and [^text]: where you want the texttext[^1] … [^1]: This is a foot note
TasksUse unordered lists but put [ ] after it or [x] to mark it done- [ ] or - [x]

Footnotes

  1. The numbers don’t have to be in order!

  2. A larger example is here: | title1 | title2 | |---|---| |row1 | row2|

  3. A larger example is here: | right | middle | left | |:---|:---:|---:| |right | middle| left |