自媒体 | 使用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和笔记直接发为博文

推荐阅读更多精彩内容