title: Sample Post - Markdown Syntax commentable: flase Edit: 2018-11-14 mathjax: true mermaid: true tags: tag1 tag2 tag3 categories: sample post
D
and other stuff like a link.This page's comment is disabled, scroll down to see.
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
$$
E=mc^2
$$
Some more text
{% raw %}
do not use {{
anywhere in your math. use { {
instead. Jekyll will parse that as liquid tags
do not use x_1
in inline math, write that as x _ 1
. Jekyll will parse that as italic.
{% endraw %}
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 <u>like this to underline.</u>
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)
.
This is a quote block
This is a quote block in side another
import numpy as np
print("""This is a python code fence""")
"This is a fortran code fence"
implicit none
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
This is horizontal line
This is inline math $\sum{i=1}^{N} i $. This is display math.
$$
\sum{i=1}^{N} i
$$
The extra empty line matters, or you will end up with
$$
\sum_{i=1}^{N} i
$$
Mathjax syntax is like latex. You cannot use \usepackge
, but you can use \newcommand
like this
$$
\newcommand{\NewOp}[2]{\lbrace{#1}\mid \otimes{#2}\rbrace}
$$
And \NewOp
will be available in all later math blocks, whether inline $\NewOp{x}{y}$ or display
$$
\NewOp{x}{y}
$$
Be very careful with the vertical bar symbol and underscore in math. If you use it like $|x|\ge 0$, $|0|=0$, or like $\lbrace x | x\gt 0\rbrace$, you will get a bunch of gibberish.
Use \vert
in $\vert x\vert\ge 0$, $\vert 0\vert=0$. Use \mid
in $\lbrace x \mid x\gt 0$ instead.
Also using underscores like this $x_1$, $x2$, $x{c_2}^{c3}$, with $y{c_2}^{c_3}$, will be processed as this.
Wrap underscores with whitespaces like this $x 1$, $x 2$, $x {c 2}^{c 3}$, with $y {c 2}^{c 3 }$.
Markdown uses ![caption](link)
to reference pictures, caption is optional. You cannot control the size.
So I prefer using HTML tags like this:
<img src="https://raw.githubusercontent.com/yk-liu/yk-liu.github.io/master/_posts/2018-11-01-Introduction-to-Homology/assets/triangles.png" width="30%">
List can have multiple lines
like this.
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?
graph LR
A[Square Rect] -- Link text --> B((Circle))
A --> C(Round Rect)
B --> D{Rhombus}
C --> D
graph TB
sq[Square shape] --> ci((Circle shape))
subgraph A subgraph
od>Odd shape]-- Two line<br/>edge comment --> ro
di{Diamond with <br/> line break} -.-> ro(Rounded<br>square<br>shape)
di==>ro2(Rounded square shape)
end
%% Notice that no text in shape are added here instead that is appended further down
e --> od3>Really long text with linebreak<br>in an Odd shape]
%% Comments after double percent signs
e((Inner / circle<br>and some odd <br>special characters)) --> f(,.?!+-*ز)
cyr[Cyrillic]-->cyr2((Circle shape Начало));
classDef green fill:#9f6,stroke:#333,stroke-width:2px;
classDef orange fill:#f96,stroke:#333,stroke-width:4px;
class sq,e green
class di orange
sequenceDiagram
loop Daily query
Alice->>Bob: Hello Bob, how are you?
alt is sick
Bob->>Alice: Not so good :(
else is well
Bob->>Alice: Feeling fresh like a daisy
end
opt Extra response
Bob->>Alice: Thanks for asking
end
end
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. |
---|---|---|
$1+1=2$ | <img src="https://raw.githubusercontent.com/yk-liu/yk-liu.github.io/master/_posts/2018-11-01-Introduction-to-Homology/assets/triangles.png" width="30%"> |
This is a note1. Footnotes can have captions like2. You can reference to the same note multiple times like[^this]. Foot notes can have many other options like3. Or just like 4. This is a reference style link to a page. And this is also a link. As is [this][] and [that].
The Foot notes are like this
> Blockquotes can be in a footnote.
as well as code blocks
or, naturally, simple paragraphs.↩