美文网首页
markdown文档编写

markdown文档编写

作者: Muggle01 | 来源:发表于2018-08-29 17:51 被阅读0次

    Markdown是一种可以使用普通文本编辑器编写的标记语言,通过简单的标记语法,它可以使普通文本内容具有一定的格式。Markdown的语法简洁明了、学习容易,而且功能比纯文本更强,因此有很多人用它写博客。

    markdown快捷键

    文本样式

    标题

    Markdown 支持两种标题的类 atx 形式

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

    # 这是 H1

    ## 这是 H2

    ###### 这是 H6

    区块引用 Blockquotes

    Markdown 标记区块引用是使用> 的引用方式,在 Markdown 文件中建立一个区块引用,那会看起来像是你自己先断好行,然后在每行的最前面加上 > ;Markdown 也允许只在整个段落的第一行最前面加上 > ;区块引用可以嵌套(例如:引用内的引用),只要根据层次加上不同数量的 > 。

    > This is the first level of quoting.

    >

    > > This is nested blockquote.

    >

    > Back to the first level.

    列表

    Markdown 支持有序列表和无序列表。无序列表使用星号、加号或是减号作为列表标记:

    * Red

    *  Green

    *  Blue

    有序列表则使用数字接着一个英文句点,很重要的一点是,在列表标记上使用的数字并不会影响输出的 HTML 结果:

    3. Bird

    1. McHale

    8. Parish

    列表项目可以包含多个段落,每个项目下的段落都必须缩进 4 个空格或是 1 个制表符,也允许只是段前缩进4个空格或一个制表符,如果要在列表项目内放进引用,那 > 就需要缩进。

    代码区块

    添加内嵌代码可以使用一对回勾号 `alert('Hello World')`.对于插入代码, Ghost支持标准的Markdown代码和GitHub Flavored Markdown (GFM)  。标准Markdown基于缩进代码行或者4个空格位或是 1 个制表符就可以,一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。

    GFM 使用三个回勾号```

    ```swift高亮显示

    分隔线

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

    ***

    *****

    - - - - - -

    区段元素

    链接

    Markdown 支持两种形式的链接语法: 行内式和参考式两种形式

    要建立一个行内式的链接,只要在方块括号后面紧接着圆括号并插入网址链接即可,如果你还想要加上链接的 title 文字,只要在网址后面,用双引号把 title 文字包起来即可,例如:

    This is [an example](http://example.com/ "Title") inline link.

    参考式的链接是在链接文字的括号后面再接上另一个方括号,而在第二个方括号里面要填入用以辨识链接的标记:

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

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

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

    强调

    Markdown 使用星号(*)和底线(_)作为标记强调字词的符号,被 * 或 _ 包围的字词会被转成用  标签包围,用两个 * 或 _包起来的话,则会被转成 ,例如:

    *single asterisks*

    _single underscores_

    但是如果 * 和 _ 两边都有空白的话,它们就只会被当成普通的符号。

    图片

    Markdown 使用一种和链接很相似的语法来标记图片,同样也允许两种样式: 行内式参考式

    行内式的图片语法看起来像是:

    ![Alt text](/path/to/img.jpg)

    ![Alt text](/path/to/img.jpg "Optional title")

    (一个惊叹号 !; 接着一个方括号,里面放上图片的替代文字;接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上 选择性的 'title' 文   字)

    参考式的图片语法则长得像:

    ![Alt text][id]

    id是图片参考的名称,图片参考的定义方式则和连结参考一样:[id]: url/to/image  "Optional title attribute"

    自动链接

    Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱,只要是用方括号包起来, Markdown 就会自动把它转成链接。一般网址的链接文字就和链接地址一样,例如:

    <http://www.baidu.com>

    反斜杠

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

    \ 反斜线;

    `  反引号

    *  星号

    _  底线

    {}  花括号

    []  方括号

    ()  括弧

    #  井字号

    +  加号

    -  减号

    .  英文句点

    !  惊叹号

    相关文章

      网友评论

          本文标题:markdown文档编写

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