自媒体 | 使用Markdown高效率编写文档

前言

  • HTML(HyperText Markup Language)是重量级的标记语言,造就了主次分明、层次清晰的网页
  • Markdown是一种轻量级的标记语言(Lightweight Markup Language),满足了主要的文本格式标记的需求,操作性大大简化,易写易读

系列文章

自媒体 | 使用Markdown高效率编写文档
自媒体 | 使用LaTeX编写数学公式
[自媒体 | 给Markdown点颜色看看] (coming soon...)


0、兼容性

市面上存在太多的Markdown编辑器,遵循以下经验有助于实现更好的兼容性:

  • 缩进

    尽量使用显式的缩紧语法,而不应该使用Tab键

    不兼容用法:Tab段落(Tab会被部分编辑器忽略)
    正确用法:  段落

  • 完整而精简

    确保没有多用或者少用标记符号

    不兼容用法:-- 列表(多余的 - )、```代码(缺少对应的 ```)
    正确用法:- 列表、```代码```

  • 空格

    不应该忽略分隔标记符与文本的空格

    不兼容用法:#一级标题(缺少分隔的空格)
    正确用法:# 一级标题

  • 转义符

    确保所有需要转义的符号都带了转义符

  • 检查

    事实上,很难确保同一篇Markdown文档在所有Markdown编辑器上保证一致的显示。在遵循以上经验的前提下,移植文档之后还需要认真检查


1、标题

  • 1.1、六级标题
    • 举例:
    # 一级标题
    ## 二级标题
    ### 三级标题
    #### 四级标题
    ##### 五级标题
    ###### 六级标题
    
    • 效果:

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题
  • 1.2、高级标题与次级标题
    • 举例:
    高级标题
    =
    次级标题
    -
    
    • 效果:

高级标题

次级标题(次级标题稍微小一些)


2、文本效果

  • 斜体

    • 举例:*斜体*、_斜体_
    • 效果:斜体斜体
  • 加粗

    • 举例:**加粗文字**、__加粗文字__
    • 效果:加粗文字加粗文字
  • 删除

    • 举例:~~删除内容~~
    • 效果:删除内容

3、引用

段落前添加一个>来标记为引用,重复使用>>可以创建更多级别的引用,使用一个空行来结束该级别。

  • 举例:
    > Markdown
    >> Markdown
    > Markdown(X 降级需要先使用一个空行结束上一级的引用)
    
    Markdown
    
  • 效果:

Markdown

Markdown
Markdown

Markdown


4、分割线

使用三个或以上的*-_来来创建分割线,符号后不能接其他内容。(注意:使用---时,在之前空一行,可以避免被当作标题标记)。

  • 举例:
***
---
___
  • 效果:



5、链接

  • 文内链接

    • 举例:
    Markdown[链接说明](http://www.baidu.com "optional hint")Markdown
    注意:网址和提示字符串之间需要空格
    
  • 引用链接
    和文内链接类似,但是它把链接的内容放在其他位置,可以使可以被识别的任意位置。

    • 举例:
    This is [链接说明] [id] 
    [id]: http://www.baidu.com/ "Optional Title Here"
    注意:网址和提示字符串之间需要空格
    
  • 超链接或邮箱
    • 举例:
    Markdown<http:www.baidu.com>Markdown
    Markdown<809072649@qq.com>Markdown
    

6、插入图片

插入图片和插入链接非常类似,只是在方括号前多一个!

  • 举例:
    [图片上传失败...(image-8361f6-1564327831975)] 
    注意:路径和提示字符串之间需要空格
    
  • 效果:

7、列表

  • 举例:

    |左对齐|中间对齐|右对齐|
    |:---|:---:|---:|
    |左1|中1|右1|
    |左2|中2|右3|
    
  • 效果:

    左对齐 中间对齐 右对齐
    左1 中1 右1
    左2 中2 右3

8、引用参考

参考内容会被放到文末,点击即可实现跳转(注意:^后的文本是任意的,会被解析成有序的数字,在参考内容后接空行来标记参考内容结束)。

  • 举例:
    使用 Markdown[^3]可以效率的书写文档, 直接转换成 HTML[^2], 你可以使用 Leanote[^Le] 编辑器进行书写。
    [^3]:Markdown是一种纯文本标记语言
    [^2]:HyperText Markup Language 超文本标记语言
    [^Le]:开源笔记平台,支持Markdown和笔记直接发为博文
    
  • 效果:
    使用 Markdown[1]可以效率的书写文档, 直接转换成 HTML[2], 你可以使用 Leanote[3] 编辑器进行书写。

9、上下角标

  • 举例:
O<sup>2</sup>
O<sub>2</sub>
  • 效果:
    O2
    O2

10、换行

<br>或者<br/>用来标记换行


11、转义

使用\进行转义


12、代码

使用两个```将代码包围起来


13、命名描记(页内超链接)

<span id="jump">跳转到的地方</span>
点击跳转


14、缩进

空格 半格 一格
&nbsp; &ensp; &emsp;
  • 举例:
    Markdown&nbsp;Markdown
    Markdown&ensp;Markdown
    Markdown&emsp;Markdown
    
  • 效果:
    Markdown Markdown
    Markdown Markdown
    Markdown Markdown

推荐阅读


感谢喜欢!你的点赞是对我最大的鼓励!欢迎关注彭旭锐的简书!


  1. Markdown是一种纯文本标记语言

  2. HyperText Markup Language 超文本标记语言

  3. 开源笔记平台,支持Markdown和笔记直接发为博文

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,924评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,902评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,716评论 0 239
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,783评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,166评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,510评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,784评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,476评论 0 196
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,196评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,459评论 2 243
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,978评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,321评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,964评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,046评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,803评论 0 193
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,530评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,420评论 2 265

推荐阅读更多精彩内容