Markdown 格式集锦 $Markdown$ 由亚伦·斯沃茨此处有掌声 (Aaron Hillel Swartz;1986年11月8日-2013年1月11日)和美国著名博客作者约翰·格鲁伯(John Gruber)合作发明了。
$Markdown$格式主要在程序员间流行,自从自己入了git的坑,就喜欢上了简洁明了的语法,除非特殊需要,已经不在接触Office系列了。^_^
这里主要列举一些$Markdown$的语法,其实只要掌握几个就能用的相当遛了。
内容目录测试 只需要加入[TOC]就可以看到内容目录了。
标题 标题共有6级,从最大的第1级到第6级,是几级就加几个#
即可。
1 2 3 4 5 6 # 标题1 ## 标题2 ### 标题3 #### 标题4 ##### 标题5 ###### 标题6
输出为:
标题1 标题2 标题3 标题4 标题5 标题6 引用 引用以>
开始,例如
输出为:
这是引用。
你想说点啥?
列表 Markdown 支持有序列表和无序列表。
无序列表使用星号、加号或是减号作为列表标记:$Markdown$ 如下所示:
等同于:
也等同于:
输出均为:
有序列表则使用数字接着一个英文句点:
1 2 3 1. Bird2. McHale3. Parish
其实1,2,3也可以写成1,3,4,但是并不影响输出信息:
Bird
McHale
Parish
强调 $Markdown$ 使用星号(*
)和底线(_
)作为标记强调字词的符号,被 *
或 _
包围的字词会被转成用斜体
,用两个 *
或 _
包起来的话,则会被转成 __粗体__,例如:
Markdown:
1 2 3 4 5 6 7 8 9 10 11 12 13 Some of these words *are emphasized* . Some of these words _are emphasized also_ . Use two asterisks for **strong emphasis** . Or, if you prefer, __use two underscores instead__ . ~~要划除的行内内容~~ <u>下划线</u> 上划线 $\overline{X}$ 下划线 $\underline{X}$
输出:
Some of these words are emphasized .
Some of these words are emphasized also .
Use two asterisks for strong emphasis .
Or, if you prefer, use two underscores instead .
下划线
所添加的需要加下划线的行内文字
$\underline{下划线}$
要划除的行内内容
上划线 $\overline{X}$ 下划线 $\underline{X}$
表格 $Markdown$插入表格的语法相对复杂,必须要按格式来敲,注意表头与内容的分割线横线-不能少于3个,$Markdown$如下所示:
1 2 3 4 第一格表头 | 第二格表头 - - - | --- 内容单元格 第一列第一格 | 内容单元格第二列第一格 内容单元格 第一列第二格 多加文字 | 内容单元格第二列第二格
输出如下:
第一格表头
第二格表头
内容单元格 第一列第一格
内容单元格第二列第一格
内容单元格 第一列第二格 多加文字
内容单元格第二列第二格
链接 链接特别简单,只要使用尖括号扩起来网址即可。
例如$Markdown$:
1 2 3 这是谷歌的地址<https://www.google.com> 。[example link ](http://example.com/).
输出为:
这是谷歌的地址https://www.google.com
也可以建立一个标签,此时需要使用 的格式例如Markdown为:
输出为:
这是谷歌的地址Google
图片 图片的格式就是在链接的基础上加上一个**!**即可,注意alt text
是在图片无法显示或找到是显示的,而Title
是在鼠标悬停到图片上显示的内容。
1 ![alt text] (/path /to /img .jpg "Title")
比如Markdown为:
1 
1 2 3 4 --- fignos-cleveref: True fignos-plus-name: 图 fignos-caption-name: 图
为了处理图形的交叉引用,我们需要添加一个 Pandoc 插件。
在终端(macOS、Linux)或者命令行(Windows)下,执行:
1 pip install pandoc-fignos
插入页首页尾的图片 1 2 3 4 5 6 7 header-includes: \usepackage {graphicx} \usepackage {fancyhdr} \pagestyle {fancy} \setlength\headheight {28pt} \fancyhead[L] {\includegraphics[width=5cm]{images.jpeg} } \fancyfoot[LE,RO] {GPIM}
插入首页一幅图片 1 2 header -includes:- \titlegraphic{\centering \includegraphics[width=10cm] {images/Ska_landscape_night_v2.jpeg }}
LaTeX公式 $ 表示行内公式: 1 质能守恒方程可以用一个很简洁的方程式 $E =mc^2 $ 来表达。
view 质能守恒方程可以用一个很简洁的方程式 $E=mc^2$ 来表达。
$$ 表示整行公式: 1 2 3 $ $ \sum_{i=1 }^n a_i=0 $ $ $ $ f(x_1,x_x,\ldots,x_n) = x_1^2 + x_2^2 + \cdots + x_n^2 $ $ $ $ \sum ^{j-1 }_{k=0 }{\widehat{\gamma }_{kj} z_k}$ $
希腊字母 1 \alpha, \beta,... \omega: \Gamma, \Delta, …, \Omega:
$\alpha .. \beta,.. \omega .. \Gamma .. \Delta .. \Omega:$
上下标
$𝑥_𝑖^2$, $log_2𝑥$
访问 MathJax 参考更多使用方法。
代码 其实$Markdown$最赞的就是代码功能了,各种个样的代码,并且可以上色,格式就是使用三个反斜点来扩起来,比如C预言为例:
1 2 3 4 5 6 7 8 ```c #include <stdio.h> int main () { return 0 ; } ```
输出为:
1 2 3 4 5 #include <stdio.h> int main () { return 0 ; }
目前支持市面上的大部分语言,比如c/c++/python/php/java等等。
方框显示 $${\boxed{BOXED\ BOLD}}$$
参考样式 参考样式类似文章中的引用文献,可以做一个标记,全部列在文末,如下所示:
1 2 3 4 5 这篇文章引用了来自 [Google] [1] 、[Yahoo] [2] 和 [MSN] [3] 的搜索结果。 [1] : http :[2] : http :[3] : http :
输出如下:
这篇文章引用了来自 Google 、Yahoo 和 MSN 的搜索结果。
脚注 在需要添加注脚的文字后加上脚注名字[^注脚名字]
,称为加注。 然后在文本的任意位置(一般在最后)添加脚注,脚注前必须有对应的脚注名字。
注意:经测试脚注与脚注之间必须空一行,不然会失效。成功后会发现,即使你没有把脚注写在文末,经Markdown转换后,也会自动归类到文章的最后。
1 2 3 4 5 6 7 使用 Markdown[^1]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。 [^1 ]:Markdown是一种纯文本标记语言 [^2 ]:HyperText Markup Language 超文本标记语言 [^Le ]:开源笔记平台,支持Markdown和笔记直接发为博文
使用 Markdown^1 可以效率的书写文档, 直接转换成 HTML^2 , 你可以使用 Typora^3 编辑器进行书写。
注:脚注自动被搬运到最后面,请到文章末尾查看,并且脚注后方的链接可以直接跳转回到加注的地方。
锚点 - 编辑器暂时木有效果 网页中,锚点其实就是页内超链接,也就是链接本文档内部的某些元素,实现当前页面中的跳转。
NB:
Markdown Extra 只支持在标题后插入锚点,其它地方无效。
Leanote 编辑器右侧显示效果区域暂时不支持锚点跳转,所以点来点去发现没有跳转不必惊慌,但是你发布成笔记或博文后是支持跳转的。
跳转到引用
嵌套HTML 其实$Markdown$的语法都可以使用HTML来实现并增强大部分的功能,比如可以使用<font>
来对字体进行设置。
颜色
$\color{red} {red text}$
Coffee break
这样就可以显示不同的颜色了。
1 2 3 4 5 6 7 8 9 10 11 12 13 浅红色文字:<font color ="#dd0000" > 浅红色文字:</font > <br /> 深红色文字:<font color ="#660000" > 深红色文字</font > <br /> 浅绿色文字:<font color ="#00dd00" > 浅绿色文字</font > <br /> 深绿色文字:<font color ="#006600" > 深绿色文字</font > <br /> 浅蓝色文字:<font color ="#0000dd" > 浅蓝色文字</font > <br /> 深蓝色文字:<font color ="#000066" > 深蓝色文字</font > <br /> 浅黄色文字:<font color ="#dddd00" > 浅黄色文字</font > <br /> 深黄色文字:<font color ="#666600" > 深黄色文字</font > <br /> 浅青色文字:<font color ="#00dddd" > 浅青色文字</font > <br /> 深青色文字:<font color ="#006666" > 深青色文字</font > <br /> 浅紫色文字:<font color ="#dd00dd" > 浅紫色文字</font > <br /> 深紫色文字:<font color ="#660066" > 深紫色文字</font > <br />
浅红色文字:浅红色文字: 深红色文字:深红色文字 浅绿色文字:浅绿色文字 深绿色文字:深绿色文字 浅蓝色文字:浅蓝色文字 深蓝色文字:深蓝色文字 浅黄色文字:浅黄色文字 深黄色文字:深黄色文字 浅青色文字:浅青色文字 深青色文字:深青色文字 浅紫色文字:浅紫色文字 深紫色文字:深紫色文字
大小 size为1:size为1 size为2:size为2 size为3:size为3 size为4:size为4 size为10:size为10
1 2 3 4 5 size 为1 :<font size ="1" >size 为1 </font><br / > size 为2 :<font size ="2" >size 为2 </font><br / > size 为3 :<font size ="3" >size 为3 </font><br / > size 为4 :<font size ="4" >size 为4 </font><br / > size 为10 :<font size ="10" >size 为10 </font><br / >
字体 1 2 3 4 5 6 <font face ="黑体" > 我是黑体字</font > <font face ="宋体" > 我是宋体字</font > <font face ="微软雅黑" > 我是微软雅黑字</font > <font face ="fantasy" > 我是fantasy字</font > <font face ="Helvetica" > 我是Helvetica字</font >
我是黑体字 我是宋体字 我是微软雅黑字 我是fantasy字 我是Helvetica字
红色字体的微软雅黑
这是黑体字 这是微软雅黑 这是华文彩云 红色字体的微软雅黑 蓝色字体的华文彩云 我是尺寸 我是黑体,绿色,尺寸为5
TODO 黄色高亮 利用 标签实现
语法 黄色高亮
页面展示效果如下:
我不知道怎么设置别的颜色的高亮,因为 html 的 style 属性和标签这里都不支持有知道的求告知。
为文字添加背景色 由于 style 标签和标签的 style 属性不被支持,所以这里只能是借助 table, tr, td 等表格标签的 bgcolor 属性来实现背景色。故这里对于文字背景色的设置,只是将那一整行看作一个表格,更改了那个格子的背景色(bgcolor)。
语法如下:
1 页面展示效果如下:
背景色蓝色 表格添加背景色 表格里的某个格子如何设置背景色呢?
参考下面的例子:
方法说明 颜色名称 颜色
此处实现方法利用 CSDN-markdown 内嵌 html 语言的优势 Hotpink rgb(240, 248, 255)
借助 table, tr, td 等表格标签的 bgcolor 属性实现背景色设置 AntiqueWhite rgb(255, 192, 203)
页面展示效果如下:
方法说明 颜色名称 颜色 此处实现方法利用 CSDN-markdown 内嵌 html 语言的优势 Hotpink rgb(240, 248, 255) 借助 table, tr, td 等表格标签的 bgcolor 属性实现背景色设置 AntiqueWhite rgb(255, 192, 203) 跨行表格 示例如下:
我占了三行
第一列
第二列
第三列
第一列
第二列
第三列
第一列
第二列
第三列
分栏 1 2 3 4 5 6 begin {columns }column {0.5 textwidth}hei column {0.5 textwidth}Oh end {columns }
begin{columns} column{0.5textwidth} hei column{0.5textwidth} Oh end{columns}
<table style="margin-left: auto; margin-right: auto;">
<tr>
<td>
<!--左侧内容-->
左侧
</td>
<td>
<!--右侧内容-->
右侧
</td>
</tr>
</table>
Works ::: columns
:::: column COLUMN 1 ::::
:::: column COLUMN 2 ::::
::::
Sphinx嵌入Markdown
甘特图 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 gantt dateFormat YYYY-MM-DD title 甘特图 section 任务清单 已完成的任务 :done, des1, 2014-01-06,2014-01-08 正在进行的任务 :active, des2, 2014-01-09, 3d 待完成任务1 : des3, after des2, 5d 待完成任务2 : des4, after des3, 5d section 核心研发 已完成的关键任务 :crit, done, 2014-01-06,24h 已完成的关键任务2 :crit, done, after des1, 2d 正在进行的关键任务 :crit, active, 3d 待完成的关键任务 :crit, 5d 待完成任务 :2d 待完成任务2 :1d section 文档编写 描述甘特图语法 :active, a1, after des1, 3d 完成甘特图实例1 :after a1 , 20h 完成甘特图实例2 :doc1, after a1 , 48h
Markdown Sphinx可以使用 [recommonmark 来支持Markdown的格式文档。
参考:https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html
配置 为了配置Sphinx支持 Markdown ,根据下面步骤操作即可:
安装 recommonmark :
1 $ pip install --upgrade recommonmark
添加 recommonmark 到可支持扩展 list of configured extensions
:
1 extensions = ['recommonmark' ]
如果希望不只是.md
后缀的也按照Markdown解析,可以使用 source_suffix
,如下使Sphinx 将.md
和 .txt
解析为Markdown:
1 2 3 4 5 source_suffix = { '.rst' : 'restructuredtext' , '.txt' : 'markdown' , '.md' : 'markdown' , }
You can further configure recommonmark to allow custom syntax that standard CommonMark doesn’t support. Read more in the recommonmark documentation .
参考 https://pandoc.org/MANUAL.html
https://sspai.com/post/57082
(17条消息) 【Markdown笔记】设置字体颜色_dadalaohua的博客-CSDN博客_markdown 颜色