Markdown语法

程序代码区块

和程序相关的写作或是标签语言原始代码通常会有已经排版好的程序代码区块,通常这些区块我们并不希望它以一般段落文档的方式去排版,而是照原来的样子显示,Markdown 会用 <pre><code> 标签来把程序代码区块包起来。

要在 Markdown 中建立程序代码区块很简单,只要简单地缩排 4 个空白或是 1 个 tab 就可以,例如,下面的输入:

This is a normal paragraph:

    This is a code block.

Markdown 会转换成:

<p>This is a normal paragraph:</p>

<pre><code>This is a code block.
</code></pre>

这个每行一级的缩排(4 个空白或是 1 个 tab),都会被移除,例如:

Here is an example of AppleScript:

    tell application "Foo"
        beep
    end tell

会被转换为:

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
    beep
end tell
</code></pre>

一个程序代码区块会一直持续到没有缩排的那一行(或是文档结尾)。

在程序代码区块里面, &<> 会自动转成 HTML 实体,这样的方式让你非常容易使用 Markdown 插入范例用的 HTML 原始代码,只需要复制贴上,再加上缩排就可以了,剩下的 Markdown 都会帮你处理,例如:

    <div class="footer">
        &copy; 2004 Foo Corporation
    </div>

会被转换为:

<pre><code>&lt;div class="footer"&gt;
    &amp;copy; 2004 Foo Corporation
&lt;/div&gt;
</code></pre>

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