markdown语法

使用 Markdown 的优点

  • 专注你的文字内容而不是排版样式，安心写作。
  • 轻松的导出 HTML、PDF 和本身的 .md 文件。
  • 纯文本内容，兼容所有的文本编辑器与字处理软件。
  • 随时修改你的文章版本，不必像字处理软件生成若干文件版本导致混乱。
  • 可读、直观、学习成本低。

标题

第一种方式

利用 = （最高阶标题）和 - （第二阶标题），大于2的任何数量的 = 和 - 都可以有效果。

1
2
3
4
最高阶标题类似html的h1
==
第二阶标题类似html的h2
--

效果

最高阶标题类似html的h1

第二阶标题类似html的h2

第二种方式

行首插入 1 到 6 个 # ，对应到标题 1 到 6 阶对应html的h1到h6.在井号后加一个空格，这是最标准的 Markdown 语法。

1
2
3
# 这是 H1
## 这是 H2
###### 这是 H6

效果

这是 H1

这是 H2

这是 H6

列表

列表的显示只需要在文字前加上 - 或 * 即可变为无序列表，有序列表则直接在文字前加1. 2. 3. 符号要和文字之间加上一个字符的空格。
无序列表

1
2
3
* 1
* 2
* 3

  • 1
  • 2
  • 3

有序列表

1
2
3
1. 1
2. 2
3. 3

  1. 1
  2. 2
  3. 3

引用

  • Markdown 标记区块引用是使用类似 email 中用 > 的引用方式。
  • Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >。
  • 区块引用可以嵌套（例如：引用内的引用），只要根据层次加上不同数量的 >。
  • 引用的区块内也可以使用其他的 Markdown 语法，包括标题、列表、代码区块等。

这是一个标题。

  1. 这是第一行列表项。
  2. 这是第二行列表项。

给出一些例子代码：

return shell_exec("echo $input | $markdown_script");

链接

行内式

只要在方块括号后面紧接着圆括号并插入网址链接即可，如果你还想要加上链接的 title 文字，只要在网址后面，用双引号把 title 文字包起来即可。

1
[显示文字](url "title")

点击百度跳转

参考式

  • 定义标记，[id]: https://www.baidu.com "百度"
  • 链接是在链接文字的括号后面再接上另一个方括号，而在第二个方括号里面要填入用以辨识链接的标记。
    1
    2
    [id]: https://www.baidu.com  "百度"
    点击这个也去 [百度] [id].

点击这个也去 百度.

下面这个是省略写法：

1
2
[Google][]
[Google]: http://google.com/

图片

图片与连接相比在前面加一个叹号就可以了。

1
2
3
4
5
![Alt text](/path/to/img.jpg "Optional title")

![Alt text][id]

[id]: url/to/image  "Optional title attribute"

粗体与斜体

Markdown 的粗体和斜体也非常简单，用两个 包含一段文本就是粗体的语法，用一个 包含一段文本就是斜体的语法。

1
2
*你好*
**还好**

你好 斜体
还好粗体

代码框和代码区块

代码框

需要用两个 ` 把中间的代码包裹起来。

1
`alert(123);`

首行空4格或一个制表符,上方需要空一行。

1
alert(123);

alert(123);

代码区

分别用三个反引号包裹起来。

1
2
3
\ ` \ ` \ `
alert(123);
\ ` \ ` \ `

代码高亮。选择代码语言，可以在三个反引号后直接跟语言名称。例如：python，JavaScript，c#，java等。

1
2
3
4
5
6
7
@requires_authorization
class SomeClass:
    pass

if __name__ == '__main__':
    # A comment
    print 'hello world'

1
alert("123123");

分割线

你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线，行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线。

1
2
3
4
5
6
7
8
9
* * *

***

*****

- - -

---------------------------------------

表格

  • 表格与块之间需要加一空行。否则表格被转义后原样输出了。
  • 不管是哪种方式，第一行为表头，第二行分隔表头和主体部分，第三行开始每一行代表一个表格行；
  • 列与列之间用管道符号 “|” 隔开，原生方式的表格每一行的两边也要有管道符。
  • 可在第二行指定不同列单元格内容的对齐方式，默认为左对齐，在 “-” 右边加上 “:” 为右对齐，在 “-” 两侧同时加上 “:” 为居中对齐。
    1
    2
    3
    4
    5
    | Name | Academy | score | 
    | - | :-: | -: | 
    | Harry Potter | Gryffindor| 90 | 
    | Hermione Granger | Gryffindor | 100 | 
    | Draco Malfoy | Slytherin | 90 |
Name Academy score
Harry Potter Gryffindor 90
Hermione Granger Gryffindor 100
Draco Malfoy Slytherin 90

复选框

1
2
3
4
5
- [ ] 支持以 PDF 格式导出文稿
- [ ] 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
- [x] 新增 Todo 列表功能
- [x] 修复 LaTex 公式渲染问题
- [x] 新增 LaTex 公式编号功能
  • 支持以 PDF 格式导出文稿
  • 改进 Cmd 渲染算法，使用局部渲染技术提高渲染效率
  • 新增 Todo 列表功能
  • 修复 LaTex 公式渲染问题
  • 新增 LaTex 公式编号功能

推荐文章