学习MarkDown语法(1)

    现在基本上所有的私下项目都放到GitHub上了,所以需要写ReadMe.md了。。以前都不知道怎么写的,

都是拿文本编辑器写了了事。不过,最近由于上线了Malayans项目,这是我准备作为我的毕业设计备选方

案之一的项目,所以我需要好好对待了。所以专程去学习了MarkDown,这边就写下我的笔记吧。

    第一:段落和换行

    一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。

「由一个或多个连续的文本行组成」这句话其实暗示了 Markdown 允许段落内的强迫换行(插入换行符),这个特性和其他大部分的
text-to-HTML 格式不一样(包括 Movable Type 的「Convert Line
Breaks」选项),其它的格式会把每个换行符都转成 <br /> 标签。

如果你确实想要依赖 Markdown 来插入 <br /> 标签的话,在插入处先按入两个以上的空格然后回车。

的确,需要多费点事(多加空格)来产生 <br /> ,但是简单地「每个换行都转换为 <br />」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引用 和多段落的 列表 在使用换行来排版的时候,不但更好用,还更方便阅读。

    Markdown 支持两种标题的语法,类 Setext 和类 atx 形式。

    类 Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),例如:

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

    任何数量的 =- 都可以有效果。

    类 Atx 形式则是在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶,例如:

    # 这是 H1

    ## 这是 H2

    ###### 这是 H6

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

    # 这是 H1 #
    

    ## 这是 H2 ##
    

    ### 这是 H3 ######

    第三:区块引用 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.

    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.

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

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

    任何像样的文本编辑器都能轻松地建立 email 型的引用。例如在 BBEdit 中,你可以选取文字后然后从选单中选择增加引用阶层

Leave a Reply

Your email address will not be published. Required fields are marked *