Markdown: Basics (快速入门)

声明: 这份文档派生(fork)于繁体中文版,在此基础上进行了繁体转简体工作,并进行了适当的润色。此文档用 Markdown 语法编写,你可以到这里查看它的源文件。「繁体中文版的原始文件可以查看这里」—By @riku注: 本项目托管于 GitCafe上,请通过”派生”和”合并请求”来帮忙改进本项目。

Getting the Gist of Markdown’s Formatting Syntax

此页提供了 Markdown 的简单概念, 语法说明 页提供了完整详细的文档,说明了每项功能。但是 Markdown 其实很简单就可以上手,此页文档提供了一些范例,并且每个范例都会提供输出的 HTML 结果。 其实直接试试看也是一个很不错的方法, Dingus 是一个网页应用程序,你可以把自已编写的 Markdown 文档转成 XHTML。

段落和换行

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进。 「由一个或多个连续的文本行组成」这句话其实暗示了 Markdown 允许段落内的强迫换行(插入换行符),这个特性和其他大部分的 text-to-HTML 格式不一样(包括 Movable Type 的「Convert Line Breaks」选项),其它的格式会把每个换行符都转成 <br /> 标签。 如果你_确实_想要依赖 Markdown 来插入 <br /> 标签的话,在插入处先按入两个以上的空格然后回车。 的确,需要多费点事(多加空格)来产生 <br /> ,但是简单地「每个换行都转换为 <br />」的方法在 Markdown 中并不适合, Markdown 中 email 式的 区块引用 和多段落的 列表 在使用换行来排版的时候,不但更好用,还更方便阅读。

!<文字颜色、字体、字号 CSDN扩展请看这里。>

注意:以下是我自行添加入内容及总结方法。
Markdown语法会忽略首行开头的空格,如果要体现出首行开头空两个的效果,可以使用 全角符号下的空格 ,windows下使用 shift+空格 切换。
-删除线
—说明
使用 ~~ 表示删除线。
—示例
~~这是一条删除线~~
这是一条删除线
—注意

  1. 注意 ~~ 和 要添加删除线的文字之间不能有空格。

  2. 我常使用在显示的告诉自己这行文字是要删除的。

-注脚
—说明
使用 [^footer] 表示注脚。
—示例
`这是一个注脚测试footer1

footer1. 这是一个测试,用来阐释注脚。`

这是一个注脚测试[^footer1]。

表格

说明 具体使用方式请看示例。

  • ------: 为右对齐。
  • :------ 为左对齐。
  • :------: 为居中对齐。
  • ------- 为使用默认居中对齐。

示例

|         序号    |    交易名    |    交易说明    |    备注    |
|    ------: |    :-------:    |    :---------   |    ------    |
|    1    |    prfcfg    |    菜单配置    |    可以通过此交易查询到所有交易码和菜单的对应关系    |
|    2    |    gentmo    |    编译所有交易    |    |
|    100000    |    sysdba    |    数据库表模型汇总    |    |

序号

交易名

交易说明

备注

1

prfcfg

菜单配置

可以通过此交易查询到所有交易码和菜单的对应关系

2

gentmo

编译所有交易

100000

sysdba

数据库表模型汇总

注意 每个Markdown解析器都不一样,可能左右居中对齐方式的表示方式不一样。 注意 我常在需要解释一个名词,或者一本书,或者一个人时使用脚注标记。

段落、标题、区块代码

一个段落是由一个以上的连接的行句组成,而一个以上的空行则会划分出不同的段落(空行的定义是显示上看起来像是空行,就被视为空行,例如有一行只有空白和 tab,那该行也会被视为空行),一般的段落不需要用空白或换行缩进。 Markdown 支持两种标题的语法,Setextatx 形式。Setext 形式是用底线的形式,利用 = (最高阶标题)和 - (第二阶标题),Atx 形式在行首插入 1 到 6 个 # ,对应到标题 1 到 6 阶。 区块引用则使用 email 形式的 ‘>‘ 角括号。 Markdown 语法:

A First Level Header
====================
A Second Level Header
---------------------
Now is the time for all good men to come to
the aid of their country. This is just a
regular paragraph.
The quick brown fox jumped over the lazy
dog's back.
### Header 3
> This is a blockquote.
>
> This is the second paragraph in the blockquote.
>
> ## This is an H2 in a blockquote

输出 HTML 为:
`

A First Level Header

A Second Level Header

Now is the time for all good men to come to the aid of their country. This is just a regular paragraph.

The quick brown fox jumped over the lazy dog's back.

Header 3

This is a blockquote.

This is the second paragraph in the blockquote.

This is an H2 in a blockquote

` * 如果 `>` 和 `>>` 嵌套使用的话,从 `>>` 退到 `>` 时,必须之间要加一个空格或者 `>` 作为过渡,否则默认为下一行和上一行是同一级别的引用。如示例所示。 * 引用标记里可以使用其他标记,如:有序列表或无序列表标记,代码标记等。 ### 修辞和强调 Markdown 使用星号和底线来标记需要强调的区段。 Markdown 语法: Some of these words *are emphasized*. Some of these words _are emphasized also_. Use two asterisks for **strong emphasis**. Or, if you prefer, __use two underscores instead__. 输出 HTML 为:

Some of these words are emphasized. Some of these words are emphasized also.

Use two asterisks for strong emphasis. Or, if you prefer, use two underscores instead.

列表

无序列表使用星号、加号和减号来做为列表的项目标记,这些符号是都可以使用的,使用星号:

* Candy.
* Gum.
* Booze.

加号:

+ Candy.
+ Gum.
+ Booze.

和减号

- Candy.
- Gum.
- Booze.

都会输出 HTML 为:

<ul>
<li>Candy.</li>
<li>Gum.</li>
<li>Booze.</li>
</ul>

有序的列表则是使用一般的数字接着一个英文句点作为项目标记:

1. Red
2. Green
3. Blue

输出 HTML 为:

<ol>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ol>

如果你在项目之间插入空行,那项目的内容会用 <p> 包起来,你也可以在一个项目内放上多个段落,只要在它前面缩排 4 个空白或 1 个 tab 。

* A list item.
    With multiple paragraphs.
* Another item in the list.

输出 HTML 为:

<ul>
<li><p>A list item.</p>
<p>With multiple paragraphs.</p></li>
<li><p>Another item in the list.</p></li>
</ul>

注意:

  1. 无序列表或有序列表标记和后面的文字之间要有一个空格隔开。
  2. 有序列表标记不是按照你写的数字进行显示的,而是根据当前有序列表标记所在位置显示的,如示例1所示。
  3. 无序列表的项目符号是按照实心圆、空心圆、实心方格的层级关系递进的,如例2所示。通常情况下,同一层级使用同一种标记表示,便于自己查看和管理。
  4. 无序列表和有序列表标记的使用场景也很明了,故不多说。

链接

Markdown 支援两种形式的链接语法: _行内_ 和 _参考_ 两种形式,两种都是使用角括号来把文字转成连结。 行内形式是直接在后面用括号直接接上链接:

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

输出 HTML 为:

<p>This is an <a href="http://example.com/">
example link</a>.</p>

你也可以选择性的加上 title 属性:

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

输出 HTML 为:

<p>This is an <a href="http://example.com/" title="With a Title">
example link</a>.</p>

参考形式的链接让你可以为链接定一个名称,之后你可以在文件的其他地方定义该链接的内容:

I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"

输出 HTML 为:

<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from <a href="http://search.yahoo.com/"
title="Yahoo Search">Yahoo</a> or <a href="http://search.msn.com/"
title="MSN Search">MSN</a>.</p>

title 属性是选择性的,链接名称可以用字母、数字和空格,但是不分大小写:

I start my morning with a cup of coffee and
[The New York Times][NY Times].
[ny times]: http://www.nytimes.com/

输出 HTML 为:

<p>I start my morning with a cup of coffee and
<a href="http://www.nytimes.com/">The New York Times</a>.</p>

图片

图片的语法和链接很像。 行内形式(title 是选择性的):

![alt text](/path/to/img.jpg "Title")

参考形式:

![alt text][id]
[id]: /path/to/img.jpg "Title"

上面两种方法都会输出 HTML 为:

<img src="/path/to/img.jpg" alt="alt text" title="Title" />

代码

在一般的段落文字中,你可以使用反引号 ` 来标记代码区段,区段内的 &<> 都会被自动的转换成 HTML 实体,这项特性让你可以很容易的在代码区段内插入 HTML 码:

I strongly recommend against using any `<blink>` tags.
I wish SmartyPants used named entities like `&mdash;`
instead of decimal-encoded entites like `&#8212;`.

输出 HTML 为:

<p>I strongly recommend against using any
<code>&lt;blink&gt;</code> tags.</p>
<p>I wish SmartyPants used named entities like
<code>&amp;mdash;</code> instead of decimal-encoded
entites like <code>&amp;#8212;</code>.</p>

如果要建立一个已经格式化好的代码区块,只要每行都缩进 4 个空格或是一个 tab 就可以了,而 &<> 也一样会自动转成 HTML 实体。 Markdown 语法:

If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:
<blockquote>
<p>For example.</p>
</blockquote>

输出 HTML 为:

<p>If you want your page to validate under XHTML 1.0 Strict,
you've got to put paragraph tags in your blockquotes:</p>
<pre><code>&lt;blockquote&gt;
&lt;p&gt;For example.&lt;/p&gt;
&lt;/blockquote&gt;
</code></pre>

转义

说明 使用 \ 表示反斜杠。在你不想显示Markdown标记时可以使用反斜杠。 示例

\*这里不会显示斜体\*

这里不会显示斜体

-其它

不常用标记

3.1 实现页内跳转

3.1.1 说明 使用html代码实现页内跳转。在要跳转到的位置定义个锚 <span id = "jump">hehe</span> ,然后使用 [你好](#jump)你好 设置为一单击即跳转到 hehe 所在位置的效果。 3.1.2 示例

[你好](#jump)
<span id = "jump">hehe</span>

你好 hehe

3.1.3 注意 无。

4. 专项使用标记

4.1 流程图 以后在总结吧,现在的我完全没有使用上,没有需求就先不总结了。 4.2 LaTeX公式 以后在总结吧,现在的我完全没有使用上,没有需求就先不总结了。


有关于文字的操作。再markdown上并没有可以直接利用的语言。所以CSDN为我们进行了扩展:

  • 换行
    • 方法1: 连续两个以上空格+回车
    • 方法2:使用html语言换行标签:<br>
  • 首行缩进两个字符:(每个表示一个空格,连续使用两个即可)
    • &ensp; 半角的空格
    • &emsp; 全角的空格
  • 字体、字号与颜色:Markdown是一种可以使用普通文本编辑器编写的标记语言,通过类似HTML的标记语法,它可以使普通文本内容具有一定的格式。但是它本身是不支持修改字体、字号与颜色等功能的! CSDN-markdown编辑器是其衍生版本,扩展了Markdown的功能(如表格、脚注、内嵌HTML等等)!对,就是内嵌HTML,接下来要讲的功能就需要使用内嵌HTML的方法来实现。 字体,字号和颜色编辑如下代码

    <font face="黑体">我是黑体字</font>
    <font face="微软雅黑">我是微软雅黑</font>
    <font face="STCAIYUN">我是华文彩云</font>
    <font color=#0099ff size=7 face="黑体">color=#0099ff size=72 face="黑体"</font>
    <font color=#00ffff size=72>color=#00ffff</font>
    <font color=gray size=72>color=gray</font>
    Size:规定文本的尺寸大小。可能的值:从 1 到 7 的数字。浏览器默认值是 3
    
具体颜色分类及标记请参照:[各种颜色](http://blog.csdn.net/testcs_dn/article/details/45719357/)
  • 背景色: Markdown本身不支持背景色设置,需要采用内置html的方式实现:借助 table, tr, td 等表格标签的 bgcolor 属性来实现背景色的功能。举例如下:

    <table><tr><td bgcolor=orange>背景色是:orange</td></tr></table>
    
效果如下:

背景色是:orange

2015/12/19 16:04:07
  • 分割线:你可以在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。你也可以在星号或是减号中间插入空格。下面每种写法都可以建立分隔线
  • 链接:链接文字都是用 [方括号] 来标记,在方块括号后面紧接着圆括号并插入网址链接即可:可参照 [This link](http://example[.NET](http://lib.csdn.net/base/dotnet ".NET知识库")/) has no title attribute.
  • 代码块

    • 代码块:用2个以上TAB键起始的段落,会被认为是代码块(效果如下):

      struct {
        int year;
        int month;
        int day;
       }bdate;
      
*   如果在一个行内需要引用代码,只要用反引号`引起来就好(Esc健)
*   代码块与语法高亮:在需要高亮的代码块的前一行及后一行使用三个反引号“`”,同时第一行反引号后面表面代码块所使用的语言
  • 插入互联网上图片: ![这里写图片描述](http://img3.douban.com/mpic/s1108264.jpg)
  • 使用LaTex数学公式:
    • 行内公式:使用两个”$”符号引用公式:
    • 行间公式:使用两对“$$”符号引用公式: $$$公式$$$

具体:详见参考颜色值

(っ•̀ω•́)っ✎⁾⁾ 坚持技术学习、内容输出与分享,您的支持将鼓励我继续创作!(*/ω\*)
( • ̀ω•́ )✧如有疑问或需要技术讨论,请留言或发邮件到 aclearzhang@qq.com.(*・ω< ) 
  • 本文作者:: AClearZhang
  • 本文链接:: 581.html
  • 版权声明: 本博客所有文章除特别声明外,均采用 CC BY-NC-SA 3.0 许可协议。转载请注明出处!