首页 > 技术文章 > Markdown基础教程

helianxiaowu 2020-09-15 17:35 原文

markdown是一种轻量级标记语言,在2004年由约翰·格鲁伯(英语:John Gruber)创建。markdown编写的文档可以导出为多种格式,如:html,word,图片,pdf,Epub等,后缀为 .md 或者 .markdown。
 
markdown被许多网站用来编写帮助文档或者用于论坛上发布消息,如:java项目的readme.md,GitHub,简书,reddit,Diaspora,Stack Exchange,OpenStreetMap ,SourceForge等。
 
markdown可以用 Typora 编辑器来编辑,支持Windows、Linux、OSX等系统,Typora官网地址:https://typora.io/ 。
 
标题
可以使用两种方法表示标题,推荐使用第二种
第一种使用两个 = 或 - 分别表示一级标题和二级标题
 
 
第二种,使用 # 表示标题,一个 # 表示一级标题,两个 # 表示二级标题,总共可以表示六级标题。需要注意的是 # 后面要加一个空格
 
 
段落
段落没什么特殊格式,直接编写就可以了。需要注意的是如果想要切换段落有点特殊,需要多敲一个空行或者在前一段落后面敲两个空格在回车
 
 
 
字体样式
使用一对 * 或 _ 表示斜体,使用两对表示粗体,使用三对表示粗斜体。
使用三个或三个以上的 * 或 _ 表示分割线
使用两对 ~ 表示删除线
使用html标签 <u> 表示下划线
 
 
 
脚注
脚注类似于变量解释,是对文档中的某段内容进行解释,一般解释会放到文档末尾,语法为 [^key]
 
 
 
列表
用 * 或 + 或 - 加上空格表示无序列表,效果都一样。嵌套的列表需要在前面加上4个空格
用数字加上点加上空格表示有序列表。嵌套列表需要在前面加上4个空格
 
 
 
区块
区块使用 > 表示,如果嵌套就用多个 > 表示
 
 
 
代码块
代码块分为单行代码块和多行代码块,其中多行代码块有几种书写方式,请根据情况自行选择
使用一对 ` 可以表示一行代码
使用三对 ` 可以表示一段代码
使用三对 ` 加上语言类型,可以在编写代码块时指定代码的语言类型
使用四个空格或制表符也可以开始一段代码块的编写,推荐用法
 
 
 
链接
可以使用三种方式表示链接,请分情况使用。推荐使用第一种
第一种,[名称](地址)
第二种,<地址> ,这种方式要求地址为 http:// 或 https:// 开头
第三种,[名称](key),在文末对key进行解释说明
 
 
 
图片
可以使用三种方式表示图片,请分情况使用。推荐使用第一种
第一种,使用 <img>标签,语法和html相同。如果你的图片需要设置宽和高,请使用这种方式
 
 
 
第二种,![alt](地址 "title"),其中title是可选参数,鼠标滑过图片时会显示该参数。图片找不到时会显示alt参数
 
 
 
第三种,![alt][key],在文末对key进行说明
 
 
 
表格
使用 | 表示不同的单元格
使用 - 分割表头和其他行,分割时可以指定对其方式。:---表示左对齐,---:表示右对齐,:---:表示居中对齐
 
 
 
高级技巧
markdown支持html标签,支持的标签有:<kbd> <b> <i> <em> <sup> <sub> <br>等
markdown可以使用反斜杠转义字符
 
 

-- 赫连小伍原创,转载请注明出处,微信公众号同名

推荐阅读