美文网首页
Markdown语法说明

Markdown语法说明

作者: Hey丶MrReliable | 来源:发表于2016-03-29 16:44 被阅读0次

    今天是来简书真正意义上的第一天,通过简书学到了不少东西,作为一个不怎么会码字的人,从今天开始,我也试着码码字,既能对自己有个提高,同时也希望对其他人有所帮助.. 希望我能坚持下去。

    刚来简书,之前也从来没有在任何平台上面写过东西的小白,在打通我码字之路的第一站,肯定是对码字工具有所了解,一个人要是同时具有完美主义、强迫症和选择恐惧症的话,那估计这个人就没治了,经常会把自己陷入一个极其纠结而且无法自拔的处境。很荣幸,我就这样的人。所以在选择用什么工具码字上我就遇到了很大的困难,经过痛苦的挣扎,最后还是决定了Markdown。我坚信这是一个正确的选择。好了废话不多说了,从这里开始我就要正式介绍Markdown的简单语法了。

    一、宗旨

    Markdown 的目标是实现「易读易写」。
    可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。

    二、特殊字符自动转换

    在 HTML 文件中,有两个字符需要特殊处理:<&< 符号用于起始标签,& 符号则用于标记 HTML 实体,如果你只是想要显示这些字符的原型,你必须要使用实体的形式,像是 <&& 字符尤其让网络文档编写者受折磨,如果你要打「AT&T」 ,你必须要写成「AT&T」。而网址中的 &字符也要转换。比如你要链接到:

    http://images.google.com/images?num=30&q=larry+bird
    

    你必须要把网址转换写为:

    http://images.google.com/images?num=30&q=larry+bird
    

    才能放到链接标签的 href属性里。不用说也知道这很容易忽略,这也可能是 HTML 标准检验所检查到的错误中,数量最多的。
    Markdown 让你可以自然地书写字符,需要转换的由它来处理好了。如果你使用的&字符是 HTML 字符实体的一部分,它会保留原状,否则它会被转换成 &
    不过需要注意的是,code 范围内,不论是行内还是区块, <&两个符号都一定会被转换成 HTML 实体,这项特性让你可以很容易地用 Markdown 写 HTML code (和 HTML 相对而言, HTML 语法中,你要把所有的 <& 都转换为 HTML 实体,才能在 HTML 文件里面写出 HTML code。)

    三、区块元素

    标题

    Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。类 Setext 形式是用底线的形式,利用 =(最高阶标题)和 -(第二阶标题),例如:

    This is an H1
    =============
    
    This is an H2
    -------------
    

    效果如下:
    This is an H1
    =============

    This is an H2

    任何数量的 =-都可以有效果。
    Atx 形式则是在行首插入 1 到 6 个 #,对应到标题 1 到 6 阶,例如:

    # 这是 H1
    
    ## 这是 H2
    
    ###### 这是 H6
    

    效果如下:

    这是 H1

    这是 H2

    这是 H6

    你可以选择性地「闭合」atx 样式的标题,这纯粹只是美观用的,若是觉得这样看起来比较舒适,你就可以在行尾加上 #,而行尾的# 数量也不用和开头一样(行首的井字符数量决定标题的阶数):

    # 这是 H1#
    
    ## 这是 H2##
    
    ###### 这是 H6######
    

    效果如下:

    这是 H1#

    这是 H2##

    这是 H6######

    区块引用 Blockquotes

    Markdown 标记区块引用是使用类似 email 中用 >的引用方式。如果你还熟悉在 email 信件中的引言部分,你就知道怎么在 Markdown 文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行的最前面加上 >

    > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
    > consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
    > Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
    > 
    > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
    > id sem consectetuer libero luctus adipiscing.
    

    这里是效果:

    This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
    consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

    Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
    id sem consectetuer libero luctus adipiscing.

    Markdown 也允许你偷懒只在整个段落的第一行最前面加上 >

    > This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
    consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
    Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
    > Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse id   
    sem consectetuer libero luctus adipiscing.
    

    区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 >

    > This is the first level of quoting.
    >
    > > This is nested blockquote.
    >
    > Back to the first level.
    

    效果:

    This is the first level of quoting.

    This is nested blockquote.

    Back to the first level.

    引用的区块内也可以使用其他的 Markdown 语法,包括标题、列表、代码区块等:

    > ## 这是一个标题。
    >
    > 1. 这是第一行列表项。
    > 2. 这是第二行列表项。
    > 
    > 给出一些例子代码:
    >
    > return shell_exec("echo $input | $markdown_script");
    

    效果:

    这是一个标题。

    1. 这是第一行列表项。
    2. 这是第二行列表项。

    给出一些例子代码:

    return shell_exec("echo $input | $markdown_script");

    列表

    Markdown 支持有序列表和无序列表。

    无序列表使用星号*、加号+或是减号-作为列表标记、其效果都是相同的:

    * Red
    * Green
    * Blue
    

    有序列表则使用数字接着一个英文句点:

    1. Bird
    2. McHale
    3. Parish
    

    四、代码区块

    和程序相关的写作或是标签语言原始码通常会有已经排版好的代码区块,通常这些区块我们并不希望它以一般段落文件的方式去排版,而是照原来的样子显示,Markdown 会用 <pre><code>标签来把代码区块包起来。要在 Markdown 中建立代码区块很简单,只要简单地缩进 4 个空格或是 1 个制表符就可以,例如,下面的输入:

    这是一个普通段落: 
              这是一个代码区块。
    

    五、分隔线

    你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线:

        * * *
    
        ********
    
        - - -
    
        ---------------------------------------
    

    六、区段元素

    链接

    Markdown 支持两种形式的链接语法: 行内式参考式两种形式。
    不管是哪一种,链接文字都是用 [方括号] 来标记。
    要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

    This is [an example](http://example.com/ "Title") inline link.
    [This link](http://example.net/) has no title attribute.
    

    效果如下:
    This is an example inline link.
    This link has no title attribute.

    链接内容定义的形式为:

    方括号(前面可以选择性地加上至多三个空格来缩进),里面输入链接文字
    -接着一个冒号
    -接着一个以上的空格或制表符
    -接着链接的网址
    -选择性地接着 title 内容,可以用单引号、双引号或是括弧包着
    下面这三种链接的定义都是相同:

    [foo]: http://example.com/ "Optional Title Here"
    [foo]: http://example.com/ 'Optional Title Here'
    [foo]: http://example.com/ (Optional Title Here)
    

    代码

    如果要标记一小段行内代码,你可以用反引号把它包起来(`),例如:

    Use the `printf()` function.
    

    图片

    很明显地,要在纯文字应用中设计一个「自然」的语法来插入图片是有一定难度的。Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式参考式。行内式的图片语法看起来像是:

    ![android](http://img3.imgtn.bdimg.com/it/u=2908778524,1170280397&fm=11&gp=0.jpg)
    ![友趣儿](http://img1.imgtn.bdimg.com/it/u=125408856,3426822001&fm=21&gp=0.jpg)
    
    androidandroid
    interestpalinterestpal
    详细叙述如下:
    -一个惊叹号!
    -接着一个方括号,里面放上图片的替代文字
    -接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文字。

    七、其他

    反斜杠

    Markdown 可以利用反斜杠来插入一些在语法中有其它意义的符号,例如:如果你想要用星号加在文字旁边的方式来做出强调效果(但不用 <em>标签),你可以在星号的前面加上反斜杠:

    \*literal asterisks\*
    

    Markdown 支持以下这些符号前面加上反斜杠来帮助插入普通的符号:

    \ 反斜线
    ` 反引号
    * 星号
    _ 底线
    {} 花括号
    [] 方括号
    () 括弧
    # 井字号
    + 加号
    - 减号
    . 英文句点
    ! 惊叹号
    

    好了,到这里Markdown的相关知识就算告一段落了。从今天开始,我将会开启我的码字之旅了。希望在提升自己的情况下也能多多少少的帮助到别人。

    相关文章

      网友评论

          本文标题:Markdown语法说明

          本文链接:https://www.haomeiwen.com/subject/ausslttx.html