markdown命令教程

最新推荐文章于 2025-03-17 09:40:21 发布

阿尔发go

最新推荐文章于 2025-03-17 09:40:21 发布

阅读量416

点赞数

分类专栏：编辑器文章标签： vscode

本文链接：https://blog.youkuaiyun.com/zhayushui/article/details/79910958

版权

编辑器专栏收录该内容

11 篇文章

订阅专栏

文章目录

Markdown及扩展
离线写博客
浏览器兼容
markdown写ppt
风格：
语法规则Warnning

推荐参考

推荐使用 vscode + markdown 插件

以下内容是本人的使用记录

Markdown及扩展

Markdown 是一种轻量级标记语言，它允许人们使用易读易写的纯文本格式编写文档，然后转换成格式丰富的HTML页面。 —— [ 维基百科 ]

使用简单的符号标识不同的标题，将某些文字标记为粗体或者斜体，创建一个链接等，详细语法参考帮助？。

本编辑器支持 Markdown Extra , 　扩展了很多好用的功能。具体请参考Github.

字体

语法

*斜体*
**粗体**
==荧光字体==

效果：
斜体
粗体
荧光字体

各种画图

推荐vscode插件 Mermaid
参考1 流程图、序列图、饼图、甘特图
参考2 VScode画流程图（最全教程）

示例1 mermaid语法

graph TB;
subgraph 分情况
A(开始)-->B{判断}
end
B--第一种情况-->C[第一种方案]
B--第二种情况-->D[第二种方案]
B--第三种情况-->F{第三种方案}
subgraph 分种类
F-.第1个.->J((测试圆形))
F-.第2个.->H>右向旗帜形]
end
H---I(测试完毕)
C--票数100---I(测试完毕)
D---I(测试完毕)
J---I(测试完毕)

示例1效果

其它示例参考mermaid官网

空格

空格1个字符

&emsp;

空格2个字符

&emsp;&emsp;

插入图片

![alt 属性文本](图片链接 "可选标题")

alt 属性文本：图片的Alt标签，用来描述图片的关键词，可以不写。最初的本意是方便搜索引擎根据alt 属性文本里面的关键词搜索到图片。
图片链接：可以是图片的本地地址或者是网址。
“可选标题”：鼠标悬置于图片上会出现的标题文字，可以不写。

CheckList

语法

- [ ] Item1
- [x] Item2

效果

Item1
Item2

表格

Markdown　Extra　表格语法：

项目	价格
Computer	$1600
Phone	$12
Pipe

空表格实体可用：

&nbsp;    #主要后面的分号;也要邪少

可以使用冒号来定义对齐方式：

项目	价格	数量
Computer	1600 元	5
Phone	12 元	12
Pipe	1 元	234

###定义列表

Markdown　Extra　定义列表语法：
项目１
项目２
: 定义 A
: 定义 B

项目３

定义 C

定义 D

定义D内容

代码块

代码块语法遵循标准markdown代码，例如：

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
class SomeClass:
    pass
>>> message = '''interpreter
... prompt'''

脚注

示例代码：

生成一个脚注[^footnote].
 [^footnote]: 这里是 **脚注** 的 *内容*.

示例效果：

生成一个脚注¹.

数学公式

使用MathJax渲染LaTex 数学公式，详见math.stackexchange.com.

行内公式，数学公式为： $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$ 。
块级公式：

$\dfrac{-b \pm \sqrt{b^2 - 4ac}}{2a}$

更多LaTex语法请参考这儿.

vscode的markdown支持仅Ketax公式，不支持latex公式。
参考：https://www.jianshu.com/p/0ea47ae02262
主要参考：https://blog.youkuaiyun.com/Leytton/article/details/103745169/
主要参考：https://blog.youkuaiyun.com/coco56/article/details/98477502

UML 图:

可以渲染序列图：

或者流程图：

关于 序列图 语法，参考这儿,
关于 流程图 语法，参考这儿.

离线写博客

即使用户在没有网络的情况下，也可以通过本编辑器离线写博客（直接在曾经使用过的浏览器中输入write.blog.youkuaiyun.com/mdeditor即可。Markdown编辑器使用浏览器离线存储将内容保存在本地。

用户写博客的过程中，内容实时保存在浏览器缓存中，在用户关闭浏览器或者其它异常情况下，内容不会丢失。用户再次打开浏览器时，会显示上次用户正在编辑的没有发表的内容。

博客发表后，本地缓存将被删除。

用户可以选择把正在写的博客保存到服务器草稿箱，即使换浏览器或者清除缓存，内容也不会丢失。

**注意：**虽然浏览器存储大部分时候都比较可靠，但为了您的数据安全，在联网后，请务必及时发表或者保存到服务器草稿箱。

浏览器兼容

目前，本编辑器对Chrome浏览器支持最为完整。建议大家使用较新版本的Chrome。
IE９以下不支持
IE９，１０，１１存在以下问题
1. 不支持离线功能
2. IE9不支持文件导入导出
3. IE10不支持拖拽文件导入

markdown写ppt

用 Markdown 做幻灯片
 用Markdown写一个极客范儿的PPT

html 快捷键命令：
h键: 展示帮助
←和→键: : 上/下一张幻灯片
Esc键: 展示目录
b键: 显示当前是第几张幻灯片
b键: 屏幕全黑
e键: 使当前幻灯片最大化
3键: 展示伪3D效果
c键: 取消显示前后幻灯片预览，只显示当前幻灯片

风格：

Markdown进阶（更改字体、颜色、大小，设置文字背景色，调整图片大小设置居中）

语法规则Warnning

MD001 - Heading levels should only increment by one level at a time
标题级数每次只能扩大1, 也就是不能隔级创建标题（从1级到6级的顺序）

MD002 - First heading should be a top level heading
文档的第一个标题必须是最高级的标题（标题等级1级到6级逐渐降低）

参数：
“level”：指定最高级标题的级数，默认是1

MD003 - Heading style
整篇文档要采用一致的标题格式

参数：
“style”：字符串，指定文档标题的格式，有(“consistent”, “atx”, “atx_closed”, “setext”, “setext_with_atx”, “setext_with_atx_closed”)五种，默认是"consistent"，也就是整篇文档一致

标题格式必须统一，一般不能混用，但"setext_with_atx", "setext_with_atx_closed"格式可以在"setext"格式二级标题后接着使用"atx"或"atx_closed"格式的标题

MD004 - Unordered list style
整篇文档定义无序列表的格式要一致

参数：
“style”：字符串，指定无序列表的定义格式，有(“consistent”, “asterisk”, “plus”, “dash”, “sublist”)五种，分别表示“定义时符号前后一致”，“用星号定义”，“用加号定义”，“用减号定义”，“定义多重列表时用不同的符号定义”，默认是"consistent"

MD005 - Inconsistent indentation for list items at the same level
同一级的列表缩进必须一致
在有序列表中，前面的数字序号可以左对齐，也可以右对齐

MD006 - Consider starting bulleted lists at the beginning of the line
1级列表不能缩进

MD007 - Unordered list indentation
无序列表嵌套缩进时默认采用两个空格

参数：
“ident”：指定无序列表嵌套时缩进的空格数，默认是2

MD009 - Trailing spaces
行尾最多可以添加两个空格，超过会给出警告，两个空格正好可以用于换行

参数：
“br_spaces”：指定在行尾可以添加的空格数目，空格数目建议大于等于2，如果小于2，会默认为0，也就是不允许任何行尾的空格
“list_item_empty_lines”：字符串，指定在列表中是否(true or false)用默认的空格数缩进空行，有的解释器会要求列表中的空行要缩进

MD010 - Hard tabs
不能使用tab键缩进，要使用空格

参数：
“code_blocks”：指定本条规则在代码块里是否(true or false)生效

MD011 - Reversed link syntax
检查内联形式的链接的创建方式是否错误，中括号和圆括号是否用对

MD012 - Multiple consecutive blank lines
文档中不能有连续的空行，在代码块中此规则不会生效

参数：
“maximum”：指定文档中可以连续的最多空行数，默认值是1

MD013 - Line length
默认行的最大长度是80，此规则对代码块、表格、标题也生效

参数：
“line_length”：指定行的最大长度，默认是80
“heading_line_length”：指定标题行的最大长度，默认是80
“code_blocks”：指定规则是否(true or false)对代码块生效，默认true
“tables”：指定规则是否(true or false)对表格生效，默认true
“hesdings”：指定规则是否(true or false)对标题生效，默认true

MD014 - Dollar signs used before commands without showing output
在代码块中，终端命令前不需要有美元符号 $
如果代码块中既有终端命令，也有命令的输出，则终端命令前可以有美元符号($)，如：

$ ls
foo bar
$ cat foo
hello world
MD019 - Multiple spaces after hash on atx style heading
在"atx"格式的标题中，#号和文字间只能用一个空格隔开，不能有多余的空格

MD020 - No space inside hashes on closed atx style heading
在"closed_atx"格式的标题中，文字和前后的#号之间需用一个空格隔开

MD021 - Multiple spaces inside hashes on closed atx style heading
在"closed_atx"格式的标题中，文字和前后的#号之间只能用一个空格隔开，不能有多余的空格

MD022 - Headings should be surrounded by blank lines
标题行的上下行必须都是空行

参数：
“lines_above”：指定标题行上方的空行数，默认为1，可以设为更大或0
“lines_below”：指定标题行下方的空行数，默认为1，可以设为更大或0

注意当此处的空行设为比1大的数时，规则MD012的设置也要改

MD023 - Headings must start at the beginning of the line
标题行不能缩进

MD024 - Multiple headings with the same content
文档不能有内容重复的标题

参数：
“siblings_only”：默认为false，设为true时，不同标题下的子标题内容可以重复

MD025 - Multiple top level headings in the same document
同一文档只能有一个最高级的标题，默认是只能有一个1级标题

参数：
“level”：指定文档最高级的标题，默认是1
“front_matter_title”：字符串，指定在文档开头处的front matter中的标题，这个标题将作为整篇文档的最高级标题，如果文档中再次出现最高级标题，将会给出警告，另外，如果不想在front matter中指定标题，就把本参数的值设置为""

MD026 - Trailing punctuation in heading
标题行末尾不能有以下标点符号：".,;:!?"

参数：
“punctuation”：字符串，指定标题行尾不能有的标点符号，默认是".,;:!?"

此规则默认的是英文的标点符号，中文标点符号不在规则之内

MD027 - Multiple spaces after blockquote symbol
创建引用区块时，右尖括号 ( > ) 和文字之间有且只能有一个空格

MD028 - Blank line inside blockquote
两个引用区块间不能仅用一个空行隔开或者同一引用区块中不能有空行，如果一行中没有内容，则这一行要用>开头

MD029 - Ordered list item prefix
有序列表的前缀序号格式必须只用1或者从1开始的加1递增数字(“one_or_ordered”)

参数：
“style”：字符串，指定前缀序号的格式，(“one”,“ordered”,“one_or_ordered”,“zero”)，分别表示只用1做前缀，用从1开始的加1递增数字做前缀，只用1或者从1开始的加1递增数字做前缀，只用0做前缀，默认值是"one_or_ordered"

本条规则支持在前缀序号中补0，以实现对齐，如：

MD030 - Spaces after list markers
列表（有序、无序）的前缀符号和文字之间用1个空格隔开
在列表嵌套或者同一列表项中有多个段落时，无序列表缩进两个空格，有序列表缩进3个空格

参数：
“ul_single”,“ol_single”,“ul_multi”,“ol_multi”：分别规定无序列表单个段落，有序列表单个段落，无序列表多个段落，有序列表多个段落的前缀符号和文字之间的空格数，默认是1

MD031 - Fenced code blocks should be surrounded by blank lines
单独的代码块前后需要用空行隔开（除非是在文档开头或末尾），否则有些解释器不会解释为代码块

MD032 - Lists should be surrounded by blank lines
列表（有序、无序）前后需要用空行隔开，否则有些解释器不会解释为列表
列表的缩进必须一致，否则会警告

MD033 - Inline HTML
文档中不允许使用HTML语句

参数：
“allowed_elements”：自定义允许的元素，是一个字符串数组，默认是空(empty)

MD034 - Bare URL used
单纯的链接地址需要用尖括号 (<>) 包裹，否则有些解释器不会解释为链接

MD035 - Horizontal rule style
创建水平线时整篇文档要统一(consistent)，要和文档中第一次创建水平线使用的符号一致

参数：
“style”：字符串，指定创建水平线的方式，值有：(“consistent”,"***","—","___")，默认是"consistent"

MD036 - Emphasis used instead of a heading
不能用强调代替标题

参数：
“punctuation”：字符串，指定用于结尾的标点符号，以此符号结尾的强调不会被视为以强调代替标题，默认值是".,;:!?"

此规则会检查只包含强调的单行段落，如果这种段落不是以指定的标点符号结尾，则会被视为以强调代替标题，会给出警告

MD037 - Spaces inside emphasis markers
用于创建强调的符号和强调的的文字之间不能有空格

MD038 - Spaces inside code span elements
当用单反引号创建代码段的时候，单反引号和它们之间的代码不能有空格
如果要把单反引号嵌入到代码段的首尾，创建代码段的单反引号和嵌入的单反引号间要有一个空格隔开

MD039 - Spaces inside link text
链接名和包围它的中括号之间不能有空格，但链接名中间可以有空格，如：

[百度]
(http://www.baidu.com “百度”)

MD040 - Fenced code blocks should have a language specified
单独的代码块（此处是指上下用三个反引号包围的代码块）应该指定代码块的编程语言，这一点有助于解释器对代码进行代码高亮

MD041 - First line in file should be a top level heading
文档的第一个非空行应该是文档最高级的标题，默认是1级标题

参数：
“level”：指定文档最高级的标题，默认是1
“front_matter_title”：字符串，指定在文档开头处的front matter中的标题，这个标题将作为整篇文档的最高级标题，另外，如果不想在front matter中指定标题，就把本参数的值设置为""

MD042 - No empty links
链接的地址不能为空

MD043 - Required heading structure
要求标题遵循一定的结构，默认是没有规定的结构(“null”)

参数：
“headings”：字符串数组，指定标题需要遵循的结构，默认是"null"，可以自行指定结构，如；

星号(*)表示对应的标题是可选的，没有强制要求，本条具体可以参照MD043

MD044 - Proper names should have the correct capitalization
指定一些名称，会检查它是否有正确的大写

参数：
“names”：字符串数组，指定要检查需要大写的名称，默认是空(“null”)
“code_blocks”：指定本规则是否(true or false)对代码块生效，默认是true
一些经常使用的名称可以使用本规则防止其拼写错误，比如JavaScript中字母J和S需要大写，就可以写到参数"names"中，防止写错

MD045 - Images should have alternate text (alt text)
图片链接必须包含描述文本（alt text）

MD046 - Code block style
整篇文档采用一致的代码格式

参数：
“style”: 字符串，指定代码块定义格式，有（“consistent”,“fenced”,“indented”）三种，分别代表：文档上下文一致，使用三个反引号隔开，使用缩进，默认是上下文一致

MD047 - Files should end with a single newline character
文档需用一个空行结尾