Markdown is a lightweight markup language with plain text formatting syntax. Its design allows easy conversion to HTML and other formats, and its syntax is influenced by Perl. Markdown is often used to format readme files, for writing messages in online discussion forums, and to create rich text using a plain text editor. Here I will teach you how to use markdown, both basic syntax and our custom site-specific syntax.
Our editor features IntelliSense. Type / to see available commands, or : for emoji selection. You can create headers, lists, tables and basically anything using our IntelliSense.
Headers are defined by the number of # symbols before the text. The number of # symbols determines the size of the header. The maximum number of # symbols is 6.
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6
Hyperlinks are defined by the text you want to display in square brackets followed by the URL in round brackets.
[example link](https://example.com)
Text styles are defined by wrapping the text in asterisks or underscores. Single asterisks is interpreted as italics, double asterisks is interpreted as bold, and triple asterisks is interpreted as bold italics.
*Italics* _Italics_ **Bold** __Bold__ ***Bold Italics*** ___Bold Italics___
Lists are defined using - or * symbols, followed by text. Either a hyphen or an asterisk can be used. Numbered lists are defined using numbers followed by a period.
- Item 1
- Item 2
- Item 3
1. First item
2. Second item
3. Third item
Checklists are defined by using - [ ] for an unchecked box and - [x] the - can be replaced with an * as well.
- [ ] Unchecked box
- [x] Checked box
Strikethrough's are defined using ~~ symbols before and after the text you want to strikethrough, this is very useful for todo lists among other things.
~~very secret information~~
Blockquotes are defined using the > symbol followed by the text you want to standout, this is usually used for quotes or as a substitute callouts.
> Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit...
Code is defined using the ` symbol. Inline code is defined by wrapping the code in singular backticks. Block code is defined by wrapping the code in triple backticks. Code blocks allow for syntax highlighting by specifying the language after the first set of triple backticks.
`git clone https://github.com/itzcozi/markd.git`
```py
number1 = 1
number2 = 2
print(number1 + number2)
```
Images are defined similarly to hyperlinks, but with an exclamation mark in front of the square brackets and the text in the rounded brackets is the media's web address.
Dividers are defined by three or more hyphens, asterisks, or underscores creating a horizontal line.
---
***
___
Tables are defined by using pipes | to separate columns and hyphens - to separate the header row from the content.
| Header 1 | Header 2 |
|----------|----------|
| Cell 1 | Cell 2 |
Admonitions are defined by using the > symbol followed by the type of admonition you want to use and the text you want to display. The admonition types are [!NOTE], [!IMPORTANT], [!TIP], [!CAUTION] and [!WARNING].
> [!NOTE]
> Something *Noteworthy*
Subscript is defined using two of the ~ symbol followed by the text you want to be subscripted. Superscript is defined using two the caret ^ symbol followed by the text you want to be superscripted.
H~2~O is a liquid. 2^10^ is 1024.
or
$H_20$ is a liquid. $2^{10}$ is 1024.
Math is defined using the $$ symbol followed by an equation in LaTeX format, then followed by an ending set of double dollar signs.
$$
f(5) = (5 - 5)^2 = 0
$$
$$
\text{slope} = \frac{f(5) - f(4)}{-1} = \frac{0 - 1}{-1} = 1
$$
Math preview:
Our editor allows for HTML code to be used in the same file as markdown. This is useful for centering text and other more complex things markdown doesn't support natively. We give users lots of power with this...
Created by BadDeveloper and Pasithea with 💙