Markdown使用

基本语法

换行

行尾加两个空格,然后加return

  • 不换行
    测试
    哈哈

    效果如下:

    测试 哈哈

  • 换行
    测试
    哈哈

    效果如下:

    测试
    哈哈

加粗

加粗字前后都使用两个*号或者_
**加粗**
__加粗__

效果如下:

加粗
加粗
加粗

斜体

在斜体字前后加一个*号或者_
*斜体*

效果如下:

斜体

标题

  • 一种方式:一级标题可以在标题下一行使用=号,二级标题可以在标题下一行使用-

  • 另一种方式:总共可以有六级标题,分别在标题前面使用1-6个#号分别表示对应的标题等级
    一级标题
    =
    二级标题
    -

    效果如下:

    一级标题

    二级标题

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

    效果如下:

    一级标题

    二级标题

    三级标题

    四级标题

    五级标题
    六级标题

链接和邮箱

  • 自动链接,在链接前后使用<>
    <http://www.baidu.com>
    <uranusjr@gmail.com>

    效果如下:

    http://www.baidu.com
    uranusjr@gmail.com

  • 行内链接[]()[]里面为链接标题,()里面为链接地址
    [百度](http://www.baidu.com)

    效果如下:

    百度

  • 引用链接[][][]:***,其中第一个[]里面为链接标题,第二个[]里面为链接标识id,第三个[]里面链接标识id,其后面为真实url
    [GitHub](gitHub_id)
    [gitHub_id]:https://github.com

    效果如下:

    GitHub

图片

  • 行内链接,使用![]()里面为图片本地或网络地址,地址后面可选图片标题
    ![网络图片1] (http://upload-images.jianshu.io/upload_images/1768589-173b2734f0487253.jpg "net_image1")

    效果如下:

    网络图片1

    ![本地图片1] (local_image.jpg "local_image1")

    效果如下:

    本地图片1
  • 引用链接,使用![][],[]:***,其中第一个[]里面为图片标题,第二个[]里面为图片标识id,第三个[]里面为图片标识id,其后面为图片本地或网络地址,地址后面可选图片标题
    ![网络图片2][net_image]
    [net_image]:https://imgt.388g.com/allimg/160711/5-160G10T615.jpg "net_image2"

    效果如下:

    网络图片2
    网络图片2

    ![本地图片2][local_image]
    [local_image]:local_test.gif "local_image2"

    效果如下:


    本地图片2

列表

  • 列表前必须有空行(或块元素)

  • 无序列表使用*-

  • 列表内条目可以使用缩进进行嵌套

    • 无序列表
      • 一级嵌套
        • 二级嵌套
          • 三级嵌套
  • 有序列表可以使用数字+.+空格的方式标识顺序

    • 有序列表
      1. 序号1
      2. 序号2
      3. 序号3

引用

  • 使用>进行引用,只要段落之间没有空行,并不是每一行都需要以>开头
    > 筚路蓝缕,以启山林
    君子和而不同,小人同而不和
    德不孤,必有邻

    >己所不欲,勿施于人

    效果如下:

    筚路蓝缕,以启山林
    君子和而不同,小人同而不和
    德不孤,必有邻

    己所不欲,勿施于人

  • 引用可以嵌套
    > 三军可夺帅也,匹夫不可夺志也
    > > 见贤思齐焉,见不贤而内自省也
    > > > 朝闻道,夕死可矣

    效果如下:

    三军可夺帅也,匹夫不可夺志也

    见贤思齐焉,见不贤而内自省也

    朝闻道,夕死可矣

  • 大部分Markdown语法都可以在块引用中使用
    > * 列表
    [百度](https://www.baidu.com)
    ![图片](http://upload-images.jianshu.io/upload_images/1768589-b07325f8a8178d14.jpg)
    [简书][jianshu_id]
    [jianshu_id]:https://www.jianshu.com

    效果如下:

代码

  • 行内代码,行内代码使用`表示,如果代码中有反引号code has `backticks `需要显示,可以使用双反引号``code has `backticks` ``

  • 缩进代码,缩进代码可以使用至少4个空格或者1个Tab回退

    print('缩进代码')
    print('缩进代码前必须有空白行')

    效果如下:

        print('缩进代码')
        print('缩进代码前必须有空白行')
    
  • 代码块

    • 在代码前后使用`

      ```
      print('代码块')
      ```

      效果如下:

      print('代码块')
      
    • 也可以使用~代替`

      ~~~
      print('代码块')
      ~~~

      效果如下:

      print('代码块')
      
    • 在第一列末尾加上language ID支持代码高亮,支持的语言及语言id见链接

      ~~~python
      foo = (1,2,3,4)
      bar = (5,6,7,8)
      for f,b in zip(foo,bar):
      print f,b
      ~~~

      效果如下:

      foo = (1,2,3,4)
      bar = (5,6,7,8)
      for f,b in zip(foo,bar):
          print f,b
      

      ```objective-c
      - (void)testFunction{
      for (UIView *view in self.view.subviews) {
      NSLog(@"%@",NSStringFromCGRect(view.frame));
      }
      }
      ```

      效果如下:

      - (void)testFunction{
          for (UIView *view in self.view.subviews) {
              NSLog(@"%@",NSStringFromCGRect(view.frame));
          }
      }
      

水平线

使用在一行中使用***或者---,则会显示一条水平线
效果如下:



表格

  • 使用|分割不同的列,在第一列下面使用---分割不同的行,使用:设置对其方式,表格前面必须有空白行

    First Column|Second Column
    ---|---
    年龄|18
    性别|男
    民族|汉
    

    效果如下:

    First Column Second Column
    年龄 18
    性别
    民族
  • 最左边和最右边的管道|只是美观性的,可以省略;每一行排版并不重要,对齐完全取决于:标记,表格的列宽是由内容决定

    | Left Aligned  | Center Aligned  | Right Aligned |
    |:------------- |:---------------:| -------------:|
    | col 3 is      | some wordy text |         $1600 |
    | col 2 is      | centered        |           $12 |
    | zebra stripes | are neat        |            $1 |
    

    效果如下:

    Left Aligned Center Aligned Right Aligned
    col 3 is some wordy text $1600
    col 2 is centered $12
    zebra stripes are neat $1
  • 下面是支持的可选内联标记的列表

    Option name         | Markup            | Result if enabled     |
    --------------------|-------------------|-----------------------|
    Intra-word emphasis | So A\*maz\*ing    | So A<em>maz</em>ing   |
    Strikethrough       | \~~Much wow\~~    | <del>Much wow</del>   |
    Underline           | \_So doge\_       | <u>So doge</u>        |
    Quote [^quote]      | \"Such editor\"   | <q>Such editor</q>    |
    Highlight           | \==So good\==     | <mark>So good</mark>  |
    Superscript         | hoge\^(fuga)      | hoge<sup>fuga</sup>   |
    Autolink            | http://t.co       | <http://t.co>         |
    Footnotes           | [\^4]: and [\^4]: | [^4] and footnote 4  |
    
    Option name Markdown Markup Result if enabled
    斜体 So A*maz*ing So A<em>maz</em>ing
    删除线 ~~Much wow~~ <del>Much wow</del>
    下划线 \_So doge\_ <u>So doge</u>
    引用[1] "Such editor" <q>Such editor</q>
    高亮 ==So good== <mark>So good</mark>
    上标 hoge^fuga hogefuga
    链接 http://t.co http://t.co
    脚注 [^foot] [2]
    [^foot]: You don't have to use a number. Arbitrary things like `[^footy note4]` and `[^footy note4]:` will also work. But they will *render* as numbered footnotes. Also, no need to keep your footnotes in order, I will sort out the order for you so they appear in the same order they were referenced in the text body. You can even keep some footnotes near where you referenced them, and collect others at the bottom of the file in the traditional place for footnotes. 
    
    [^foot]: 脚注不需要一定用数字。任意的`[footy note4]`和`[footy note4]:`都有效,他们会按照脚注的id渲染,在文中使用了`[^foot]`标记脚注后,只有在后面用`[^foot]: `备注脚注后才能让该脚注渲染。同样的不需要保持脚注备注的顺序,Markdown将为你整理一下顺序,这样它们就会按照在文本正文中引用的顺序出现;甚至可以在引用它们的地方附近保留一些脚注,也可以在文件的底部收集其他脚注
    
    [^quote]: 引用用html<q>标签替换文字“"引号字符。引用和Smartypants在语法上是不兼容的。如果两个都启用,则引用优先。注意,引用与blockquote不同,后者是标准的Markdown的一部分
    

流程图

```flow
st=>start: 开始:>https://www.baidu.com
e=>end: print("Done")
op=>operation: a
op1=>operation: a+1
op2=>operation: a*2
op3=>operation: print(a)

cond1=>condition: a<10
cond2=>condition: a>100

st->op->cond1
cond1(yes)->op1(left)->op
cond1(no)->op2(bottom)->cond2
cond2(yes)->e
cond2(no,right)->op3(right)->op2()

效果如下:

flow_image


  1. 引用用html<q>标签替换文字“"引号字符。引用和Smartypants在语法上是不兼容的。如果两个都启用,则引用优先。注意,引用与blockquote不同,后者是标准的Markdown的一部分

  2. 脚注不需要一定用数字。任意的[footy note4][footy note4]:都有效,他们会按照脚注的id渲染,在文中使用了[^foot]标记脚注后,只有在后面用[^foot]:备注脚注后才能让该脚注渲染。同样的不需要保持脚注备注的顺序,Markdown将为你整理一下顺序,这样它们就会按照在文本正文中引用的顺序出现;甚至可以在引用它们的地方附近保留一些脚注,也可以在文件的底部收集其他脚注

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

推荐阅读更多精彩内容

  • 1. 斜体和粗体 代码: 显示效果: 这是一段斜体 这是一段粗体 这是一段加粗斜体 这是一段删除线 2. 分级标题...
    泊牧阅读 2,342评论 0 2
  • Markdown概述 宗旨 Markdown 的目标是实现「易读易写」。Markdown 的特点就是,让写作变得更...
    心疼你萌萌哒阅读 7,694评论 1 24
  • 想在简书上把自己所学的知识总结一下 以为是件很容易的事情 没想到等自己写的时候 才发现是问题重重 代码完全不听我的...
    用爱之心解爱之毒阅读 22,584评论 4 5
  • Markdown[1]使用方法 为了能更好的学习,请登陆简书。 将你的编辑器切换成Markdown编辑器,点击写文...
    Crazy丶Harvey阅读 770评论 0 3
  • 备注#####. 以下添加的格式功能都是经过简书编辑器实现。. 编辑器的模式一定要选择Markedown模式。...
    暗香有独阅读 455评论 0 1