MacDown的使用规范总结


1.标题

在MarkDown中,你只需要在文本前面加上#即可。同理,你可以增加二级标题、三级标题、四级标题、五级标题、六级标题,总共六级,只需增加#即可。标题字号相应降低,例如:

#一级标题
##二级标题
###三级标题
####四级标题
#####五级标题
######六级标题

注:#和「一级标题」之间建议保留一个字符的空格,这是最标准的MarkDown写法

2. 列表

  • 在MarkDown中,你只需要在文字卡面加上-或+就可以了,例如:

      - 文本一
      - 文本二
      - 文本三
    
  • 如果你希望有序列表,在文字前面加上1. 2. 3. 就可以了,例如:

      1. 文本一
      2. 文本二
      3. 文本三
    
  • 效果如下(前面的>符号表示引用),如果「- 文本」不是放在行首,显示的就是空心圆 :

  • 文本一

  • 文本二

  • 文本三

  1. 文本一
  2. 文本二
  3. 文本三

注:-和1. 和文本之间保留一个空格,但是后面要跟代码时,代码需要两个制表符(Tab)或8个空格,才能正常显示。

3. 链接、超链接、图片和代码

  • 在MarkDown中,插入链接时,只需要使用 [使用文本](链接地址)这样的语法就可以,例如:

    MarkDown

  • 在MarkDown中,插入超链接(网址、邮箱等)时,只需要将超链接用<>包括起来即可,例如:

    123456789@163.com

    http://www.jianshu.com

  • 在MarkDown中,插入图片时,只需要使用![](图片链接地址)这样的语法就可以,例如:


  • 在MarkDown中,建立代码区块,只要在文本前添加制表符或者4个空格就可以,例如:

      - (void)hello
      {
            nslog(@"hello world");
      }
    

注:插入图片的语法和链接的语法很像,只是前面多了一个 !。这里的[],(),!符号都是英文符号。

4. 表格

格式如下:

  • 行名居中,数据居左

    TablesAreCool
    col 3 is right-aligned $1600
    col 2 is centered $12
    zebra stripes are neat $1
  • 行名居中,数据居中

    TablesAreCool
    col 3 is right-aligned $1600
    col 2 is centered $12
    zebra stripes are neat $1
  • 行名居左,数据居左

    TablesAreCool
    col 3 is right-aligned $1600
    col 2 is centered $12
    zebra stripes are neat $1
  • 行名居右,数据居右

    TablesAreCool
    col 3 is right-aligned $1600
    col 2 is centered $12
    zebra stripes are neat $1

注:两边的竖线可有可无,但是要有都有,要无都无。

5. 其他

  • 回车

    一个回车表示换行

    两个回车表示换段

  • 引用

    在Markdown中你只需要在你希望引用的文字前面添加>就可以,例如:

    一盏灯,一片黄昏;

    注:> 和 文本之间建议保留一个空格

  • 粗体与斜体

    在MarkDown中,用两个包含一段文字就是粗体,用一个包含一段文字就是斜体,例如:

    粗体

    斜体

    粗斜体

  • 横线

    三个星号或者三个减号或者三个下划线即可生成一条虚横线,例如:




一个减号或两个减号,可以生成一条实横线(简书不支持此格式,股无法显示)

  • 文本突出显示

    只需要用``将文本包含起来,即可。例如:

    突出显示文本

  • 文本注释

    只需使用[xxx]这样的格式,就可以,但是要在文章最后面也要有相同的[xxx]去解释相应的内容,例如:

    [1]

  • 特殊符号

    文本中需要插入特殊符号时,需要在特殊符号前加上反斜杠,例如:

    #hello

    注:这里的特殊符号并不只是只单一的特殊符号,而是当特殊符号与文本或特殊符号组合形成特殊的格式时,如果需要显示特殊符号,需要加上\。如上面的#与hello组合会将hello显示为标题,如果此时需要显示#hello,需要在#前添加\。

6. 总结

以上的语法只是MarkDown的基本语法,在实际使用中往往是多个语法混合使用,具体的规则要在具体的使用中去体会。个人觉得用MarkDown来记笔记要比使用简单地文本方便得多,而且写出的东西也更加易读。

Okey,happy writing!

**注:经过一段时间的使用感觉文中提到的使用代码块的方法比较蠢,不断的制表符或空格使得文章的排版很乱,这里再介绍一种比较简单的方法,使用
```bash
代码块


  1. hello



作者:卞泽
链接:https://www.jianshu.com/p/148e26058916
來源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
posted @ 2018-02-06 11:22  爱吃醋的工程师  阅读(814)  评论(0编辑  收藏  举报