MarkDwon-语法说明

概述

本站后台使用的是MarkDown编辑器,语法自然也是MarkDown语法。
我觉得MarkDwon编辑器是一款非常好用编辑器,其语法特性决定了它用来用来记录一些文本再好不过了。

宗旨

Markdown 的目标是实现「易读易写」。

可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括 Setext、atx、Textile、reStructuredText、Grutatext 和 EtText,而最大灵感来源其实是纯文本电子邮件的格式。

兼容HTML

Markdown 是一个 Web 上使用的文本到HTML的转换工具,可以通过简单、易读易写的文本格式生成结构化的HTML文档。目前 github、Stackoverflow 等网站均支持这种格式。

Markdown 语法的目标是:成为一种适用于网络的书写语言。

Markdown 不是想要取代 HTML,甚至也没有要和它相近,它的语法种类很少,只对应 HTML 标记的一小部分。Markdown 的构想不是要使得 HTML 文档更容易书写。在我看来, HTML 已经很容易写了。Markdown 的理念是,能让文档更容易读、写和随意改。HTML 是一种发布的格式,Markdown 是一种书写的格式。就这样,Markdown 的格式语法只涵盖纯文本可以涵盖的范围。

不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。不需要额外标注这是 HTML 或是 Markdown;只要直接加标签就可以了。

使用说明

1.标题

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

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

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

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

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

# 这是 H1 #
## 这是 H2 ##
### 这是 H3 ######

2.加粗,斜体

最常用的强调方式,那就是 加粗 了,比如:

最常用的强调方式,那就是 **加粗** 了
斜体一般用在书名  直接  *这是书名*

3.列表

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

*   Red
*   Green
*   Blue

+   Red
+   Green
+   Blue

-   Red
-   Green
-   Blue

以上三种语法效果相同的

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

1.  Bird
2.  McHale
3.  Parish

在列表标记上使用的数字并不会影响输出的 HTML 结果,上面的列表所产生的 HTML 标记为:

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

4.层次

第一章

1.第一节

  • 第二节(你不用敲 "2",自动就有了)

    • 第一小节(推荐每层次缩进四个空格)

      • 小小节 1
      • 小小节 2
  • 第二小节
    MarkDwon语法如下:
#### 第一章
        1. 第一节
        * 第二节(你不用敲 "2",自动就有了)
             * 第一小节(推荐每层次缩进四个空格)
                * 小小节 1
                * 小小节 2
             * 第二小节

5.超链接,图片

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

    This is [an example](http://example.com/ "Title") inline link.
    [This link](http://example.net/) has no title attribute.
    会产生如下html代码
    <p>This is <a href="http://example.com/" title="Title">an example</a> inline link.</p>

    <p><a href="http://example.net/">This link</a> has notitle attribute.</p>
    

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

    注意:到目前为止, Markdown 还没有办法指定图片的宽高,如果你需要的话,你可以使用普通的 <img> 标签。

6.分隔线

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

* * *

***

*****

- - -

---------------------------------------

7.代码区块

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

这是一个普通段落:

这是一个代码区块。
会自动转化成
<p>这是一个普通段落:</p>

<pre><code>这是一个代码区块。
</code></pre>

一个代码区块会一直持续到没有缩进的那一行(或是文件结尾)。
在代码区块里面, & 、 < 和 > 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始码,只需要复制贴上,再加上缩进就可以了,剩下的 Markdown 都会帮你处理,例如:

<div class="footer">
  © 2004 Foo Corporation
</div>
回自动转换成
<pre><code><div class="footer">
© 2004 Foo Corporation
</div>
</code></pre>

代码区块中,一般的 Markdown 语法不会被转换,像是星号便只是星号,这表示你可以很容易地以 Markdown 语法撰写 Markdown 语法相关的文件。

8.自动链接

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

<http://example.com/>
会自动转化为
<a href="http://example.com/">http://example.com/</a>

邮址的自动链接也很类似,只是 Markdown 会先做一个编码转换的过程,把文字字符转成 16 进位码的 HTML 实体,这样的格式可以糊弄一些不好的邮址收集机器人,例如:

<address@example.com>
会自动转换为
<a href="mailto:address@example.com">address@example.com</a>

9.其他

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

\*literal asterisks\*

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

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

希望这些对大家有一些帮助咯!

谷文杰博客
请先登录后发表评论
  • 最新评论
  • 总共0条评论
  • 本站使用Laravel5.4框架程序搭建 © 2016-2017 guwenjie.freephp.top 版权所有 ICP证:京ICP备17038807号
  • 联系邮箱:guguguwenjie@163.com