Markdown Syntax Test
This page’s comment is disabled, scroll down to see.
Careful!
Don’t use []
in YAML front matter.
Use \newline
instead of \\
in inline math.
\substack
is a very useful command.
<img src="" width=80%>
will be rendered by typora but Jekyll only renders <img src="" width="80%">
Display math must have extra black lines above and below like this.
some normal text |
Highlights
This is italic. This is Bold. * If asterisk is surrounded by spaces, it is not parsed. *
This is also italic. This is also Bold. _ If underscore is surrounded by spaces, it is not parsed. _
This is strike through.
There is no underline in markdown. You can use html tags like this to underline.
This is a code block
.
This is an external link. “https://” is important. This is an internal link. Internal links are all lowercase with space replaced by hyphens “-”.
You can mix them like this, this
, this, but not like [this](https://bit.ly)
.
Blocks
This is a quote block
This is a quote block in side another
import numpy as np |
"This is a fortran code fence" |
This is a simple code fence. You can use it to display text. The fonts are mono spaced. |
You can mix them as well, like
This
Other Elements
This is horizontal line
Math Blocks
This is inline math $\sum_{i=1}^{N} i $. This is display math.
The extra empty line matters, or you will end up with
Mathjax syntax is like latex. You cannot use \usepackge
, but you can use \newcommand
like this
And \NewOp
will be available in all later math blocks, whether inline \NewOp{x}{y} or display
Be very careful with the vertical bar symbol and underscore in math. If you use it like , , or like , you will get a bunch of gibberish.
Use \vert
in , . Use \mid
in instead.
Also using underscores like this , , , with , will be processed as this.
Wrap underscores with whitespaces like this , , , with .
Images
Markdown uses ![caption](link)
to reference pictures, caption is optional. You cannot control the size.
So I prefer using HTML tags like this:
Lists
- This is unordered list
- sub item
- subsub item
- subsubsub item
- subsubsubsub …
- subsubsub item
- subsub item
- sub item
-
List can have multiple lines
like this.
- This ordered list
- sub item
- This is as well
- It can keep going
- You can avoid numbers like this
- sub item
- It keeps going
- Blah Blah
mermaid
Tables
This column is left aligned | This column is centered | This column is right aligned |
---|---|---|
1 | 4 | 7 |
2 | 5 | 8 |
3 | 6 | 9 |
You can use ![caption](link) in tables. |
You can use Math in tables. | You can use <img src="" width=""> in tables. |
---|---|---|
Foot Notes
This is a note^1. Footnotes can have captions like^this. You can reference to the same note multiple times like^this. Foot notes can have many other options like[^this-one]. Or just like [^that]. This is a reference style link to a page. And this is also a link. As is [this][] and [that].
Titles
This is h1
This is h2
This is h3
This is h4
This is h5
This is h6
Footnotes
The footnotes are like this
[^this-one]:
> Blockquotes can be in a footnote. |
as well as code blocks |
[^that]: or, naturally, simple paragraphs.