GitHub 官方默认使用的 markdown 解析器是 kramdown，他的语法和 markdown 定义的内容相差无几，只有一些些扩充，下面是一些常用的 markdown 语法以及在本博客中可能会使用到的语法内容，如果想要了解 kramdown 的语法可以参考官方的 ref。
h1 Heading
h2 Heading
h3 Heading
h4 Heading
h5 Heading
h6 Heading
Horizontal Rules
Emphasis
This is bold text
This is bold text
This is italic text
This is italic text
Blockquotes
Blockquotes with plain text
Blockquotes Text
Blockquotes with Lists
- List one
- List one.one
- List one.two
- List two
- List three
To end the Blockquotes just put an empty line under >
Lists
Unordered
- Create a list by starting a line with
+,-, or* - Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
- Ac tristique libero volutpat at
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Marker character change forces new list start:
- Very easy!
Ordered
-
Lorem ipsum dolor sit amet
This is ordered List one content
- Consectetur adipiscing elit
- Integer molestie lorem at massa
This is another ordered list
- You can use sequential numbers…
- …or keep all the numbers as
1.
Start numbering with offset:
- foo
- bar
Code
Inline code
Indented code
// Some comments
line 1 of code
line 2 of code
line 3 of code
Block code “fences”
Sample text here...This is code block...paste some code here to try
Tables
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Right aligned columns
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
Links
markdown syntax
[link text](http://einverne.github.com)
output:
Add “title text” (which shows up under the cursor)
[link with title](http://einverne.github.io/ "title text!")
output:
Most URLs will automatically be turned into links. To be explicit, just write it like this:
Autoconverted link <https://github.com/einverne>
output:
Autoconverted link https://github.com/einverne
Reference Links
You can also put the [link URL][1] below the current paragraph
like [this][2].
[1]: http://url
[2]: http://another.url "A funky title"
Output:
You can also put the link URL below the current paragraph like this.
Here the text “link URL” gets linked to “http://url”, and the lines showing “1: http://url” won’t show anything.
Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.
Or you can use a [shortcut][] reference, which links the text
"shortcut" to the link named "[shortcut]" on the next paragraph.
[shortcut]: http://goes/with/the/link/name/text
Output:
Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.
Images
To include an image, just put a “!” in front of a text link:
output:
The alternate text will show up if the brower can’t load the image. You can also use a title if you want, like this:
output:
Like links, Images also have a footnote style syntax
![Alt text][id]
[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
output:
With a reference later in the document defining the URL location:
emoji
+1 :+1:
smile :smile:
laughing :laughing:
wink :wink:
grin :grin:
cry :cry:
confused :confused:
yum :yum:
You can find the Emoji from this link
Footnotes
Footnote 1 link1.
Footnote 2 link2.
Inline footnote^[Text of inline footnote] definition.
Duplicated footnote reference2.
Abbreviations
This is HTML abbreviation example.
It converts “HTML”, but keep intact partial entries like “xxxHTMLyyy” and so on.
因为本 Jekyll 在 _config.yml 中配置使用 kramdown markdown解释器，所以更多的语法可以参考官方语法页面
公式
使用 MathJax
使用行内模式 $x^2$ 显示为 $x^2$
使用块模式，用 $$ ... 公式内容 ... $$ 来格式：
这里提供在线 LeTex 公式编辑