- Markdown is a lightweight markup language for creating formatted text using a plain-text editor
- People use it to create websites, documents, notes, books, presentations, email messages, and technical documentation.
Different ways to create heading
###### Similer to HTML <h6> tag
##### Similer to HTML <h5> tag
#### Similer to HTML <h4> tag
### Similer to HTML <h3> tag
## Similer to HTML <h2> tag
# Similer to HTML <h1> tag
Text
Paragraph
This is a paragraph. I’m typing in a paragraph isn’t this fun?
Now I’m in paragraph 2. I’m still in paragraph 2 too!
I’m in paragraph three!
This is a paragraph. I'm typing in a paragraph isn't this fun?
Now I'm in paragraph 2.
I'm still in paragraph 2 too!
I'm in paragraph three!
Style guide
- It’s very easy to make some words bold and other words italic with Markdown.
It's very easy to make some words **bold** and other words *italic* with Markdown.
This text will be italic This will also be italic
This text will be bold This will also be bold
You can combine them
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
This text is rendered with strikethrough.
~~This text is rendered with strikethrough.~~
Inline code/ Highlight
Remove views.py and serializers.py from .gitignore
Remove `views.py` and `serializers.py` from `.gitignore`
Blockquotes
We’re living the future so the present is our past.
> We're living the future so
> the present is our past.
You can also use more than one level
of indentation? How neat is that?
> You can also use more than one level
>> of indentation?
> How neat is that?
- We’re living the future
- The present is our past.
> * We're living the future
> * The present is our past.
Links & Images
[Link Url]( https://guides.github.com/features/mastering-markdown/)
http://github.com
- Embed images
Click this link for more info about it!
# There should be a gap b/w these 2 lines
[Click this link][link1] for more info about it!
[link1]: http://test.com/ "Cool!"
Horizontal rule
***
---
- - -
****************
List
Ordered list
- One
- Two
- Three
1. One
2. Two
3. Three
Unordered list
- Start a line with a star
- Profit!
* Start a line with a star
* Profit!
Alternatively,
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
- Dashes work just as well
- And if you have sub points, put two spaces before the dash or star:
- Like this
- And this
- Item
- Item
- One more item
+ Item
+ Item
+ One more item
Task list
- @mentions, #refs, links, formatting, and tags supported
- list syntax required (any unordered or ordered list supported)
- this is a complete item
- this is an incomplete item
- [x] @mentions, #refs, [links](), **formatting**, and <del>tags</del> supported
- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
Code
function fancyAlert(arg) {
if(arg) {
$.facebox({div:'#foo'})
}
}
Table
Here’s a useless table:
| Number | Next number | Previous number |
|---|---|---|
| Five | Six | Four |
| Ten | Eleven | Nine |
| Number | Next number | Previous number |
| :------ |:--- | :--- |
| Five | Six | Four |
| Ten | Eleven | Nine |
| Col 1 | Col2 | Col3 |
|---|---|---|
| Ugh this is so ugly | make it | stop |
Col 1 | Col2 | Col3
:-- | :-: | --:
Ugh this is so ugly | make it | stop
Emoji
Maths
- If the text between $$ contains newlines it will rendered in display mode:
Formula 1:
$$ \phi = \frac{(1+\sqrt{5})}{2} = 1.6180339887\cdots $$
Formula 2: (same formula, different delimiter)
\[ \phi = \frac{(1+\sqrt{5})}{2} = 1.6180339887\cdots \]
Formula 1:
$$
\phi = \frac{(1+\sqrt{5})}{2} = 1.6180339887\cdots
$$
Formula 2: (same formula, different delimiter)
\\[
\phi = \frac{(1+\sqrt{5})}{2} = 1.6180339887\cdots
\\]
Formula 3:
$$ f(x) = \int_{-\infty}^\infty\hat f(\xi),e^{2 \pi i \xi x},d\xi $$
$$
f(x) = \int_{-\infty}^\infty\hat f(\xi)\,e^{2 \pi i \xi x}\,d\xi
$$
Formula 4:
$$ \frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } } $$
$$
\frac{1}{\Bigl(\sqrt{\phi \sqrt{5}}-\phi\Bigr) e^{\frac25 \pi}} = 1+\frac{e^{-2\pi}} {1+\frac{e^{-4\pi}} {1+\frac{e^{-6\pi}} {1+\frac{e^{-8\pi}} {1+\cdots} } } }
$$
Formula 5:
$$ 1 + \frac{q^2}{(1-q)}+\frac{q^6}{(1-q)(1-q^2)} $$
$$ \cdots = \prod_{j=0}^{\infty}\frac{1}{(1-q^{5j+2})(1-q^{5j+3})} $$
$$
1 + \frac{q^2}{(1-q)}+\frac{q^6}{(1-q)(1-q^2)}
$$
$$
\cdots = \prod_{j=0}^{\infty}\frac{1}{(1-q^{5j+2})(1-q^{5j+3})}
$$
Formula 6
Remember, certain characters are rendered by markdown, so you may need to workaround those issues. You can find the complete list of KaTeX supported functions here: https://khan.github.io/KaTeX/docs/supported.html
- For example, the
'character can be replaced with^\prime: $$ G^\prime = G - u $$
$$
G^\prime = G - u
$$
- The
"character can be replaced with^{\prime\prime}: $$ G^{\prime\prime} = G^\prime - v $$
$$
G^{\prime\prime} = G^\prime - v
$$
F 8
$$ \mathop {\lim }\limits_{x \to c} \frac{{f\left( x \right)}}{{g\left( x \right)}} = \mathop {\lim }\limits_{x \to c} \frac{{f'\left( x \right)}}{{g'\left( x \right)}} $$
$$ \mathop {\lim }\limits\_{x \to c} \frac{{f\left( x \right)}}{{g\left( x \right)}} = \mathop {\lim }\limits\_{x \to c} \frac{{f'\left( x \right)}}{{g'\left( x \right)}} $$
F 9
$$ \begin{pmatrix} 0 & 1 \\ 0 & 0 \end{pmatrix}\begin{pmatrix} 0 & 0 \\ 1 & 0 \end{pmatrix}=\begin{pmatrix} 1 & 0 \\ 0 & 0 \end{pmatrix} $$
$$ \begin{pmatrix} 0 & 1 \\\\ 0 & 0 \end{pmatrix}\begin{pmatrix} 0 & 0 \\\\ 1 & 0 \end{pmatrix}=\begin{pmatrix} 1 & 0 \\\\ 0 & 0 \end{pmatrix} $$