Markdown语法

(此文最后更新于2023年12月22日。)


自从博客转入hexo后,发现markdown写文章非常方便,很快上手熟悉了,常用的网易云笔记Obsidian支持markdown语法,更加离不开了。然而有些语法不常用,容易忘记,这里对markdown语法做个总结记录,以备查询。

基本用法

标题

单个#号然后空格,h1标题,两个#号然后空格,h2标题,依次类推。

强调

斜体强调,用单个(星号)包裹;
粗体强调,用两个*
(星号)包裹;
(可以混合使用)
删除线强调,用两个~~ (删除号)包裹。

强调
强调
强调
强调

列表

有序列表
输入数字然后加. (英文字符点)然后空格。

  1. 项目一
  2. 项目二

无序列表
加号或者减号,星号,然后空格。

  • 项目
  • 项目

列表嵌套
另起一行,开头空格三次。

  1. 项目
    1. 项目

任务列表
列表内容前加一个-(连字符)然后空格,后接一对 [ ](方中括号,中间空格),然后空格。要将任务标记为已完成,可在方括号中加上x(英文字母x)。

  • 任务
  • 已完成任务

引用

普通引用
(大于号)>然后空格,如果新起一行继续加大于号,换行可以不用再加。

这是引用效果。
第二行。

1
2
> 这是引用效果。   
> 第二行。

嵌套引用

嵌套引用

继续引用下去

1
2
>嵌套引用
>> 继续引用下去

网址链接

常用链接
一般会自动识别,也可以用<>(尖括号包裹)。
给链接添加文字说明。用[](方/中括号)包裹文字说明,然后紧跟()(小括号)包裹链接地址。
https://www.jiangyu.org
天一生水

1
2
<https://www.jiangyu.org> - 网址链接,自动识别
[天一生水](https://www.jiangyu.org) --带文字说明的链接

高级链接

1
2
3
4
5
6
这个链接用 1 作为网址变量 [天一生水][1]
这个链接用 onewater 作为网址变量 [Onewater][onewater]
然后在文档的结尾为变量赋值(网址)

[1]: https://www.jiangyu.org
[onewater]: https://www.jiangyu.org

这个链接用 1 作为网址变量 天一生水
这个链接用 onewater 作为网址变量 Onewater
然后在文档的结尾为变量赋值(网址)

图片

与网址链接方法类似,前面加!(英文字符下的感叹号)

1
![图片文字描述](图片URL地址)

也可以像网址那样对图片网址使用变量

换行

在当前行结尾 TAB键 另起一行(或者在当前行结尾加 2 个空格)。
如果是要起一个新段落,只需要空出一行即可。。

分隔符

输入三个减号- 可以加入分隔符/线。
当前后都有段落时,需要空出一行。

代码

可以使用一对三个连续的```(反引号,backquote)包裹一段代码,并可以指定一种语言。

比如

1
2
3
4
5
'''javascript
$(document).ready(function () {
alert('hello world');
});
'''

使用4个空格缩进,再贴上代码,可以实现相同的的效果。
如果只想高亮语句中的某个函数名或关键字,可以使用一对单个'(反引号)包裹实现。
如你不需要代码高亮,可以用下面的方法禁用:

1
2
3
4
5
'''nohighlight
$(document).ready(function () {
alert('hello world');
});
'''

反斜杠转义

如果描述中需要用到markdown的符号,但又不想它被转义,这时候可以在这些符号前加反斜杠(\),进行避免。

高级技巧

行内 HTML 元素

支持部分段内 HTML 元素效果,包括 kdb,b,i, em,sup,sub,br等。

表格

1
2
3
4
| header 1 | header 2| 
| ---|---|
| row 1 col 1 | row 1 col 2|
| row 2 col 1 | row 2 col 2|
header 1 header 2
row 1 col 1 row 1 col 2
row 2 col 1 row 2 col 2

文献引用

这个有点复杂,Markdown原生的不支持引用,需要借助html代码实现。

1
2
3
4
5
6
7
8
9
这篇文章是介绍如何在 Markdown[<sup>1</sup>](#refer-anchor-1) 中增加文献引用。[<sup>2</sup>](#refer-anchor-2)

参考:
<div id="refer-anchor-1"></div>
1. [Markdown](https://daringfireball.net/projects/markdown/)

<div id="refer-anchor-2"></div>
2. [Wikipedia](https://en.wikipedia.org/wiki/Main_Page)

这篇文章是介绍如何在 Markdown1 中增加文献引用。2
参考:

1. [Markdown](https://daringfireball.net/projects/markdown/)
2. [Wikipedia](https://en.wikipedia.org/wiki/Main_Page)

公式

插入数学公式,要借助公式表达方式(比如LaTeX,TeX)。(需要安装或者支持诸如MathJax,katex这样的渲染器)

可以使用一对单个或者两个美元符 /$包裹。

1
2
3
$$ 
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$

参考资料:

  1. Segmentfault:Markdown 语法指南;
  2. Github:基本撰写和格式语法;
  3. GitHub Flavored Markdown Spec;
  4. Markdown 语法说明 (简体中文版);
  5. Markdown中文网;
  6. Markdown Project
奶奶去世 茶的记忆

  评论