Markdown语法指南
花了一段时间把自己的个人博客搭建好了,但是博客必须是要用Markdown书写,所以查了一下Markdown编辑器的语法,在这里做个记录。
Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。世界上最流行的博客平台WordPress和大型CMS如Joomla、Drupal都能很好的支持Markdown。完全采用Markdown编辑器的博客平台有Ghost和Typecho。
基本技巧
1 代码
如果你只想高亮语句中的某个函数名或关键字,可以使用 `function_name()
` 实现
通常编辑器根据代码片段适配合适的高亮方法,但你也可以用 ``` 包裹一段代码,并指定一种语言
1 | ```javascript |
支持的语言:actionscript, apache, bash, clojure, cmake, coffeescript, cpp, cs, css, d, delphi, django, erlang, go, haskell, html, http, ini, java, javascript, json, lisp, lua, markdown, matlab, nginx, objectivec, perl, php, python, r, ruby, scala, smalltalk, sql, tex, vbscript, xml
也可以使用 4 空格缩进,再贴上代码,实现相同的的效果
1 | def g(x): |
2 标题
文章内容较多时,可以用标题分段:
1 | 标题1 |
3 粗斜体
1 | *斜体文本* _斜体文本_ |
4 链接
4.1 常用链接方法
1 | 文字链接 ![链接名称](http://链接网址) |
4.2 高级链接技巧
1 | 这个链接用 1 作为网址变量 [Google][1]. |
5 列表
5.1 普通无序列表
1 | - 列表文本前使用 [减号+空格] |
5.2 普通有序列表
1 | 1. 列表前使用 [数字+空格] |
5.3 列表嵌套
1 | 1. 列出所有元素: |
6 引用
6.1 普通引用
1 | > 引用文本前使用 [大于号+空格] |
6.2 引用里嵌套引用
1 | > 最外层引用 |
6.3 引用里嵌套列表
1 | > - 这是引用里嵌套的一个列表 |
6.4 引用里嵌套代码块
1 | > 同样的,在前面加四个空格形成代码块 |
7 图片
7.1 跟链接的方法区别在于前面加了个感叹号 !
,这样是不是觉得好记多了呢?
1 | ![图片名称](http://图片网址) |
7.2 当然,你也可以像网址那样对图片网址使用变量
1 | 这个链接用 1 作为网址变量 [Google][1]. |
也可以使用 HTML 的图片语法来自定义图片的宽高大小
1 | <img src="htt://example.com/sample.png" width="400" height="100"> |
8 换行
如果另起一行,只需在当前行结尾加 2 个空格
1 | 在当前行的结尾加 2 个空格 |
如果是要起一个新段落,只需要空出一行即可。
9 分隔符
如果你有写分割线的习惯,可以新起一行输入三个减号-
。当前后都有段落时,请空出一行:
1 | 前面的段落 |
高级技巧
1 行内 HTML 元素
目前只支持部分段内 HTML 元素效果,包括
,如
键位显示
1 | 使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重启电脑 |
代码块
1 | 使用 <pre></pre> 元素同样可以形成代码块 |
粗斜体
1 | <b> Markdown 在此处同样适用,如 *加粗* </b> |
2 符号转义
如果你的描述中需要用到 markdown 的符号,比如 _
#
*
等,但又不想它被转义,这时候可以在这些符号前加反斜杠,如 \_
\#``\*
进行避免。
1 | \_不想这里的文本变斜体\_ |
3 扩展
支持** jsfiddle、gist、runjs、优酷视频**,直接填写 url,在其之后会自动添加预览点击会展开相关内容。
1 | http://{url_of_the_fiddle}/embedded/[{tabs}/[{style}]]/ |
4 公式
当你需要在编辑器中插入数学公式时,可以使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。提交后,问答和文章页会根据需要加载 Mathjax 对数学公式进行渲染。如:
1 | $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a}. $$ |
同时也支持 HTML 属性,如:
1 | $$ (x+1)^2 = \class{hidden}{(x+1)(x+1)} $$ |
总结
markdown语法写多了自然就会了,网上有很多markdown语法编辑器,比如有道云、马克飞象、Typora等。我目前使用的是Typora
编辑器,使用起来比其他的更简单、舒适,方便。