Markdown 參考指南

Fuchsia.dev 支援本指南中記錄的 Markdown 元素。

區塊引述符號

Markdown 使用大於字元 (>) 將文字顯示為引用文字 (也就是引用文字)

Markdown

This is a Markdown paragraph.

> This is a blockquote with two paragraphs. The first line of a blockquote
> paragraph has to have a greater-than character (`>`), but for readability
> in the source file, add a greater-than character to every subsequent line
> of the paragraph like this example. Though this isn't a requirement as
> shown in the second blockquote paragraph below.
>
> This is a second blockquote paragraph that only has a greater-than
character (`>`) for the first line. Donec sit amet nisl. Aliquam semper
ipsum sit amet velit. Suspendisse id sem consectetuer libero luctus
adipiscing. Lorem ipsum dolor sit amet, consectetuer adipiscing elit.
Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec,
fringilla in, laoreet vitae, risus.

最終顯示

此為 Markdown 段落。

此為包含兩個段落的引用文字。引用文字的第一行 段落必須大於字元 (>);但為了方便閱讀 在來源檔案中,在每一行後加入大於字元 段落如本範例所示不過,這並非必要條件 如下方第二個引用段落所示

這個部分是第二段的引用文字, 第一行的字元 (>)。Donec sit amet nisl。Aliquam Semper ipsum sit amet velit.Suspendisse id sem consectetuer libero luctus 請延伸。Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.Vestibulum enim wisi, viverra nec fringilla in、laoreet vitae、risus。

程式碼區塊

程式碼區塊可用來提供程式輔助範例或標記原始碼。內容 程式碼區塊中的字元不會像一般 Markdown 段落剖析,而是會在寫入後算繪。

您可以使用程式碼區塊指定 程式設計語言 來呈現程式碼來醒目顯示

三個倒引號前後都必須加上空白行 (```)。最終輸出內容不會顯示倒引號。 不過,最終輸出內容會顯示程式碼區塊中的空白行。

Markdown

Example 1: Uses Java syntax highlighting

```java
public class Hello {

  public static void main(String arg[]) {

    System.out.println("Hello.");
  }
}
```

Example 2: Prevents syntax highlighting

```none {:.devsite-disable-click-to-copy}
Some pseudo-code doesn't need syntax highlighting.
```

Example 3: Includes a replacement variable

```none {:.devsite-disable-click-to-copy}
Hello, my name is {{ '<var>' }}your-name{{ '</var>' }}.
```

產生的 HTML

<p>Example 1: Uses Java syntax highlighting</p>
<pre class="prettyprint lang-java"><code>public class Hello {<br/>public
static void main(String arg[]) {<br/>System.out.println("Hello.");<br/>}
<br/>}<br/></code></pre>
<p>Example 2: Prevents syntax highlighting</p>
<pre class="click-to-copy"><code><br/><p>Some pseudo-code doesn't need
syntax highlighting.</p><br/>
</code></pre>
<p>Example 3: Includes a replacement variable</p>
<pre class="no-prettyprint"><code><br/><p>Hello, my name is <var>your-name</var>.
</p><br/></code></pre>

最終顯示

範例 1:使用 Java 語法醒目顯示

public class Hello {

  public static void main(String arg[]) {

    System.out.println("Hello.");
  }
}

範例 2:禁止語法醒目顯示

Some pseudo-code doesn't need syntax highlighting.

範例 3:包含替代變數

Hello, my name is your-name.

在程式碼區塊中使用可替換的變數

如要在程式碼區塊中使用 <var> 標記,請使用 Jinja 運算式括號,如下所示:

{{ '<var>' }}PORT{{ '</var>' }}

上述範例算繪如下:

PORT

留言

Fuchsia.dev 支援 Markdown 和 HTML 中的單行和多行註解。 留言不會顯示在已發布的頁面上。這些註解有利於 文件協作者 (如果文件中含有 includecodeMathJax)。

單行註解

多行註解

如何在 fuchsia.dev 上使用多行註解:

請使用 {# ... #} 換行。這在 HTML 和 Markdown 中都適用:

{% verbatim %}
{# I wonder how drivers are doing? #}
{# I hear they are awesome! #}

自訂屬性

Fuchsia.dev 可讓您設定自訂 HTML 屬性 (例如 classidattribute='value')。

支援的 Markdown 元素

下列元素支援自訂屬性:

  • 程式碼時距
  • 程式碼區塊
  • 標題
  • 連結
  • 清單
  • 段落
  • 資料表和多行表格

格式

語法 說明
{} 自訂屬性的開始與結尾。
: 這是 fuchsia.dev 中的 Markdown 自訂屬性。
. 句號後的字詞 (.) 會設定元素的 class
# 雜湊後的字詞 (#) 會設定元素的 id
attribute='value' 設定元素的屬性名稱和值的組合;使用 來分隔配對

Markdown

This is a Markdown paragraph.
{:.customClass #custom_id attribute='value'}

產生的 HTML

<p class="customClass" id="custom_id" attribute="value">This is a Markdown paragraph.</p>

定義清單

如要在 Markdown 中建立定義清單,請一行列出字詞,然後 並在定義下方的新行前面加上冒號 (:)。

Markdown

Apple
: A fruit
: A tech company

Orange
: A citrus fruit

    A definition can also contain other block or inline elements. This is a
    paragraph within the same definition as "A citrus fruit". Elements
    within must be indented four spaces to be recognized as part of the
    preceding definition.

: A color

產生的 HTML

<dl>
  <dt>Apple</dt>
  <dd>A fruit</dd>
  <dd>A tech company</dd>

  <dt>Orange</dt>
  <dd>
    <p>A citrus fruit</p>
    <p>
      A definition can also contain other block or inline elements. This is
      a paragraph within the same definition as "A citrus fruit". Elements
      within must be indented four spaces to be recognized as part of the
      preceding definition.
    </p>
  </dd>
  <dd>
    <p>A color</p>
  </dd>
</dl>

最終顯示

Apple
水果
科技公司
Orange

柑橘類水果

定義也可以包含其他區塊或內嵌元素。這是 。Elements 必須以四個空格縮排,才能識別為 先前的定義

顏色

強調力強

Markdown 使用星號 (*) 和底線 (_) 來強調強調效果,且強烈的格式。

強調效果

一個星號 (*) 或底線 (_) 的文字會為特定文字提供斜體樣式。

Markdown

*single asterisks*

_single underscores_

supercali*fragilistic*expialidocious

supercali_fragilistic_expialidocious                 // won't format

產生的 HTML

<em>single asterisks</em>

<em>single underscores</em>

supercali<em>fragilistic</em>expialidocious

supercali_fragilistic_expialidocious

最終顯示

單一星號

單底線

超級脆弱的爆炸性

supercali_fragilistic_expialidocious

以雙星號 (**) 或底線 (__) 表示的文字會為特定文字賦予粗體樣式。

Markdown

**double asterisks**

__double underscores__

supercali**fragilistic**expialidocious

supercali__fragilistic__expialidocious

產生的 HTML

<strong>double asterisks</strong>

<strong>double underscores</strong>

supercali<strong>fragilistic</strong>expialidocious

supercali<strong>fragilistic</strong>expialidocious

最終顯示

雙星號

雙底線

超級脆弱的爆炸性

超級脆弱的爆炸性

逸出

某些字元是 Markdown 中的保留語法。如要使用特殊字元 請使用反斜線逸出 (\) 顯示下列常值字元:

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   minus sign (hyphen)
.   dot
!   exclamation mark

註腳

註腳是很實用的工具,可在內容中納入額外或補充內容。 不會幹擾網頁運作該語法類似於 參考連結:

In the main text, include a label[^1] that starts with a caret.

[^1]: The footnote content goes here.

[^2]: Longer footnote content can be span multiple lines
    by indenting the continuation 4 spaces.

註腳標籤可以是任何字串,只要開頭為 插入點 ^

標題

Markdown 支援在開頭使用 1 到 6 個雜湊字元 (#) 的 ax 樣式標頭 即可對應 1 到 6 的標題層級

Markdown

# This is an H1

## This is an H2

###### This is an H6

最終顯示

這是 H1

這是 H2

這是 H6

標頭 ID

Fuchsia.dev 支援每個標頭的自訂 HTML id 屬性。如果 如要覆寫預設值 id,請將 自訂屬性 {#user_defined_name}

Markdown

# Working with contacts {#working-with-contacts}
## Contact Entry
### Contacts are working

產生的 HTML

<h1 id="working-with-contacts">Working with contacts</h1>
<h2 id="contact-entry">Contact Entry</h2>
<h3 id="contacts-are-working">Contacts are working</h3>

目錄

針對每一個第二層和第三層標題,fuchsia.dev 會自動產生 頁面目錄 (TOC)。如要從 TOC 隱藏標頭,請新增 自訂屬性 {:.hide-from-toc}

Markdown

## Hidden in TOC {:.hide-from-toc}             // try to find it!

最終顯示

在 TOC 中隱藏

水平規則

Markdown 支援在上方放置三個或更多的水平規則標記 (<hr>) 線條、星號或底線

下列所有條件都會產生水平規則:

* * *

***

*****

- - -

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

圖片

Markdown 使用的圖片語法旨在類似語法 ,則允許兩種樣式:內嵌和參照。

每張圖片都具有以下屬性:

  • 開始驚嘆號:!
  • 一組方括號,包含 alt 屬性文字。
  • 一組括號 (內含圖片的網址或路徑) 和 選用的 title 屬性,以雙引號或單引號括住。
  • 一組使用自訂屬性語法 {: .my-custom-css-class} 的選用類別

內嵌語法

以下是有效的內嵌圖片語法:

![Alt text](/docs/images/benchmarking/test_suite_example.png)

![Alt text](/docs/images/benchmarking/test_suite_example.png "Optional title")

![Alt text](/docs/images/benchmarking/test_suite_example.png "Optional title"){: .my-custom-css-class} 

參照語法

以下是參照樣式圖片的語法:

![Alt text][{{ '' }}ID{{ '' }}]

其中「ID」 {{ '' }}{{ '' }} 是指已定義圖片參照的名稱。 圖片參照使用的語法和連結參照相同:

{% verbatim %}[ID]: docs/images/benchmarking/test_suite_example.png  "Optional title attribute"

自訂語法

您可以使用下列語法指定 Markdown 圖片的寬度:

![Alt text](/docs/images/benchmarking/test_suite_example.png){: width="123"} 

包含程式碼

includecode 標記包含來自其他檔案的文字區域,尤其是原始碼的區域。 這個標記也可以產生可下載的檔案,而不會在文字中加入 指定文件中的文字

您可以使用這個標記,將一部分原始碼插入文件中,然後維護 做為可執行檔案的原始碼

gerrit_repo+path 參數是指 Gerrit 或 Git 代管的存放區和路徑。 repo 的格式為 instance or repositorypath 的格式為 path/to/file

{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" %}

包含一部分檔案

有三種方式可以指定要納入的檔案區域:區域標記、規則運算式和縮排區塊。

區域標記

區域標記可讓您在來源檔案中新增幾行,藉此將第一行和最後一行 區域和標記名稱

{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="consts" %}

算繪時間:

const BOARD_SIZE uint8 = 9;
const NAME string = "Tic-Tac-Toe";

規則運算式

您也可以使用 regexp 參數,透過規則運算式定義要擷取的區域。 例如:

{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" regexp="WRITE = 0b010;" %}

算繪時間:

WRITE = 0b010;

此模式使用 Python 規則運算式語法。如需更多資訊 請參閱官方的 Python 說明文件

縮排區塊

您可以在函式或類別定義中加入程式碼,而不必定義區域標記。 使用 indented_block 參數:

{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" indented_block="type User" %}

算繪時間:

type User = table {
    1: age uint8;
    2: name string:MAX_STRING_LENGTH;
};

此模式使用 Python 規則運算式語法。詳情請參閱官方的 Python 說明文件

參數

以下是 includecode 的選用參數:

Markdown

參數
highlight 選填
您可以使用 highlight 參數來呼叫程式碼的特定部分。 請使用逗號分隔值來指定要醒目顯示的行。線條的編號為 (而不是整個檔案)。

範例
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" highlight="2,3,4" %}
adjust_indentation 選填
根據預設,includecode 會傳回原始碼的指定區段。 包括空白字元您可以使用 adjust_indentation選項。

adjust_indentation 會採用兩個可能的值:
  • number - 整數。這表示將每一行取消縮排的空格。 舉例來說,值 4 會將行縮排 4 個空格,-2 則會將行縮排 2 個空格。
  • 「auto」- 字串自動。發布工具會為所選程式碼取消縮排 同區找到的領先空間換句話說,此 API 會移除大部分開頭的空白字元 程式碼片段中的每一行程式碼
,瞭解如何調查及移除這項存取權。 範例
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" adjust_indentation="-2" %}
html_escape 選填
根據預設,includecode HTML 會逸出所有程式碼。 您可以設定 html_escapeFalse 來取消逸出 HTML。

範例
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/echo.test.fidl" region_tag="launcher" html_escape="False" %}
exclude_regexp 選填
您可以根據規則運算式移除特定行。這項功能對移除留言或其他文字有幫助 不相關的內容您無法使用多行規則運算式。

範例
{% includecode gerrit_repo="fuchsia/fuchsia" gerrit_path="examples/fidl/fuchsia.examples/types.test.fidl" region_tag="bits" exclude_regexp="READ" %}

最終顯示

參數
highlight highlight="2,3,4" 之前:
        bits FileMode : uint16 {
          READ = 0b001;
          WRITE = 0b010;
          EXECUTE = 0b100;
        };
敬上 highlight="2,3,4"後:
        bits FileMode : uint16 {
          READ = 0b001;
          WRITE = 0b010;
          EXECUTE = 0b100;
        };
adjust_indentation adjust_indentation="-2" 之前:
        bits FileMode : uint16 {
          READ = 0b001;
          WRITE = 0b010;
          EXECUTE = 0b100;
        };
敬上 adjust_indentation="-2"後:
            bits FileMode : uint16 {
              READ = 0b001;
              WRITE = 0b010;
              EXECUTE = 0b100;
            };
html_escape html_escape="False" 之前:
MAX_STRING_LENGTH echo_prefix, request<Echo> request);
敬上 html_escape="True"後:
MAX_STRING_LENGTH echo_prefix, request request);
exclude_regexp exclude_regexp="READ" 之前:
      bits FileMode : uint16 {
        READ = 0b001;
        WRITE = 0b010;
        EXECUTE = 0b100;
      };
敬上 exclude_regexp="READ"後:
      bits FileMode : uint16 {
        WRITE = 0b010;
        EXECUTE = 0b100;
      };

包含 Markdown 片段

你可在目前的 Markdown 檔案中納入 Markdown 檔案,以便進行一般處理,方法是使用 內含必要檔案路徑的 << >> 指令。路徑必須與 目前的 .md 來源檔案—不應使用絕對路徑。<<&gt;&gt;指令是區塊指令 因此必須單獨成行

舉例來說,如果目前的檔案 en/time-travel/example.md 要納入檔案 en/time-travel/_samples/_sample.md,它會指定:

<<_samples/_sample.md>>

內嵌程式碼

您可以使用倒引號括住文字,指定 Markdown 段落中的程式碼 引號 (`)。

Markdown

Use the `printf()` function. Code for the `printf()` function is located in the `system\ ` directory.

This sentence has inline `  {code}    ` with a lot of spaces but none are rendered.

產生的 HTML

<p>Use the <code>printf()</code> function. Code for the <code>printf()</code>
function is located in the <code>system\</code> directory.</p>
<p>This sentence has inline <code>{code}</code>with a lot of spaces but none
are rendered.</p>

最終顯示

使用 printf() 函式。printf() 函式的程式碼位於 system\ 目錄。

這個句子的內嵌 {code} 含有大量空格,但皆無法轉譯。

內嵌 HTML

Markdown 語法不提供 HTML 的所有功能。 Markdown 支援內嵌 HTML,你可以將文字自動納入 HTML 元素標記,例如:

Markdown

This sentence is in Markdown with a <b>bold inline HTML tag</b>.

最終顯示

這句在 Markdown 中以粗體內嵌 HTML 標記標示。

Fuchsia.dev 支援三種連結樣式:內嵌參照外部。 在所有樣式中,連結文字都會以 [] (方括號) 分隔。

如要建立內嵌連結,請立即使用一組一般括號 加到連結文字右方括號後方。 輸入你希望連結指向的網址,並選填 連結標題 (用引號括住)。例如:

Markdown

This is [an example](https://fuchsia.dev/ "Title") inline link.

[This link](https://fuchsia.dev/) has no title attribute.

產生的 HTML

<p>This is <a href="https://fuchsia.dev/" title="Title">
an example</a> inline link.</p>

<p><a href="fuchsia.dev">This link</a> has no
title attribute.</p>

最終顯示

這是 範例內嵌連結

這個連結沒有 title 屬性。

如果參照本機資源 (例如原始碼中的檔案),可以 使用相對路徑如需範例,請參閱 docs README

參照樣式連結會在內部使用第二組方括號 ;由您提供標籤以識別連結:

This is [an example][id] reference-style link.

您可以選擇使用空格來分隔括號組合:

This is [an example] [id] reference-style link.

接著在文件底部定義連結 單行程式碼:

[id]: https://{{example_url}}/  "Optional Title Here"

您可以新增連結,提醒讀者將導向外部網站的連結 {: .external} 新增至語法。例如:

See the [official documentation](https://my_external_website){: .external} for details.

指向 Fuchsia 原始碼或 Fuchsia 變更的連結並非外部連結。

無論您使用何種方式在內容中建立 Markdown 連結,你都可以連結至 Fuchsia.dev 提供的內容類型:

  • 由 Fuchsia 來源樹狀結構 //docs 目錄中的貢獻者建立的內容。

    範例:這是前往 //docs/get-started/learn-fuchsia.md:

    [Learn Fuchsia](/docs/get-started/learn-fuchsia.md)
    
  • 系統自動產生的內容,例如 fuchsia.dev/reference,但實際上不會 Fuchsia 來源樹狀結構中。

    範例:這是前往 fuchsia.bluetooth 產生的 API 參考說明文件:

    [`fuchsia.bluetooth`](https://fuchsia.dev/reference/fidl/fuchsia.bluetooth)
    

    Fuchsia 也包含非生成的參考內容, //docs/reference/ 目錄。 可使用 Fuchsia 來源樹狀結構內容語法建立連結。

  • 網址連結。這些連結類型必須標示為「外部」

    範例:這是 google.com 的連結:

    [`google.com`](https://google.com){: .external} 
    

清單

使用 Markdown 語法即可輕鬆建立項目符號或編號清單。 這通常稱為「未排序」(即項目符號) 或「已排序」 (編號) 清單,因為清單參照產生的清單 (<ul>) 和 (<ol>) HTML 標記。

未排序的清單

未排序的清單可以使用星號 (*)、加號 (+) 或破折號 (-) 做為清單 標記。無論您使用哪一個標記,清單都會顯示相同的結果。

Markdown

This is a Markdown paragraph:
                                             // required blank line
* Red
* Green
* Blue

This is another Markdown paragraph:
                                            // required blank line
+ Red
+ Green
+ Blue

This is yet another Markdown paragraph:
                                            // required blank line
- Red
- Green
- Blue

產生的 HTML

<p>This is a Markdown paragraph:</p>
<ul>
  <li>Red</li>
  <li>Green</li>
  <li>Blue</li>
</ul>
<p>This is another Markdown paragraph:</p>
<ul>
  <li>Red</li>
  <li>Green</li>
  <li>Blue</li>
</ul>
<p>This is yet another Markdown paragraph:</p>
<ul>
  <li>Red</li>
  <li>Green</li>
  <li>Blue</li>
</ul>

最終顯示

這是 Markdown 段落:

  • 紅色
  • Green
  • Blue

這是另一個 Markdown 段落:

  • 紅色
  • Green
  • Blue

這是另一個 Markdown 段落:

  • 紅色
  • Green
  • Blue

多層級未排序清單

您可以在*+- 多層未排序的清單第二層標記必須早於 至少四個空格,且每個層面都保持一致。請參考以下範例:

Markdown

This is a Markdown paragraph:
                              // required blank line before parent list
 * Bird
     * Celtics
     * Retired
       * Larry                // extra space; not consistent w/ "Celtics"
 * Magic
     * Lakers

產生的 HTML

<p>This is a Markdown paragraph:</p>
<ul>
  <li>Bird
    <ul>
      <li>Celtics</li>
      <li>Retired</li>
      <ul>
        <li>Larry</li>
      </ul>
    </ul>
  </li>
  <li>Magic
    <ul>
      <li>Lakers</li>
    </ul>
  </li>
</ul>

最終顯示

這是 Markdown 段落:

  • 鳥類
    • 塞爾提克
    • 退休人員
      • Larry
  • 魔法
    • 湖人隊

已排序的清單

已排序的清單會在清單項目前方加上一個數字和一個句點。您可以定義自己的序數 ,或使用 1. 自動編號。請參考以下範例:

Markdown

This is a Markdown paragraph:
                                   // required blank line
1. Bird                            // recommended numbering
1. McHale
1. Parish

This is another Markdown paragraph:
                                   // required blank line
1. Bird                            // sequential numbering is allowed,
2. McHale                          // but not recommended
3. Parish

This is yet another Markdown paragraph:
                                   // required blank line
3. Bird                            // non-sequential numbering is allowed,
1. McHale                          // but not recommended
8. Parish

產生的 HTML

<p>This is a Markdown paragraph:</p>
<ol>
  <li>Bird</li>
  <li>McHale</li>
  <li>Parish</li>
</ol>
<p>This is another Markdown paragraph:</p>
<ol>
  <li>Bird</li>
  <li>McHale</li>
  <li>Parish</li>
</ol>
<p>This is yet another Markdown paragraph:</p>
<ol>
  <li>Bird</li>
  <li>McHale</li>
  <li>Parish</li>
</ol>

最終顯示

這是 Markdown 段落:

  1. Bird
  2. McHale
  3. 教區

這是另一個 Markdown 段落:

  1. Bird
  2. McHale
  3. 教區

這是另一個 Markdown 段落:

  1. Bird
  2. McHale
  3. 教區

多層級排序清單

您可以建立多層級的排序清單。第二層標記必須早於四個空格。

Markdown

 1. Bird
     1. Lakers
 1. McHale
     1. Celtics

產生的 HTML

<ol>
  <li>Bird
    <ol>
      <li>Lakers</li>
    </ol>
  </li>
  <li>McHale
    <ol>
      <li>Celtics</li>
    </ol>
  </li>
</ol>

最終顯示

  1. 鳥類
    1. 湖人隊
  2. McHale
    1. 塞爾提克

MathJax

<devsite-mathjax> 自訂元素可讓您在 使用 MathJax 2.7 的 fuchsia.dev 內容。MathJax 使用 LaTeX 語法 在於數學運算詳情請參閱 LaTeX 語法指南

用量

如要在文件中使用 MathJax,你必須將自訂元素加入文件一次:

  {# To see the fully rendered MathJax equations on this page,
  see the published page at https://fuchsia.dev/<PATH_TO_YOUR_DOCUMENT>#}
  <devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax>

加入自訂元素後,您可以在 $$ block or $ inline.

Standalone block

Markdown

<!-- <devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax> -->

<div>
  $$
  R_{\mu\nu}-\frac{1}{2}Rg_{\mu\nu}+\Lambda{g_{\mu\nu}} = \frac{8\pi{G}}{c^4}{T_{\mu\nu}}
 $$
</div>

Rendered

$$ R_{\mu\nu}-\frac{1}{2}Rg_{\mu\nu}+\Lambda{g_{\mu\nu}} = \frac{8\pi{G}}{c^4}{T_{\mu\nu}} $$ 中編寫數學標記

Inline

Markdown

<!--Included only one time previously-->
<devsite-mathjax config="TeX-AMS-MML_SVG"></devsite-mathjax>

The area of a circle can be computed using the equation $ A = \pi{r^2} $,
where $ r $ is the radius of the circle, and $ \pi $ is the mathematical
constant that is approximately equal to 3.14159.

Rendered

The area of a circle can be computed using the equation $ A = \pi{r^2} $, where $ r $ is the radius of the circle, and $ \pi $ is the mathematical constant that is approximately equal to 3.14159.

Paragraphs

A paragraph is simply one or more consecutive lines of text, separated by one or more blank lines. (A blank line is any line that looks like a blank line -- a line containing nothing but spaces or tabs is considered blank.) You do not need to indent normal paragraphs with spaces or tabs.

Tables

Markdown makes it easy to format tables with pipes (|) and hyphens (-). Deliminate text with pipes to create columns; a header row is defined when the following row has at least three hyphens for each column header.

Markdown

Lesson                     | Description
------------------------   | ---------------------------------------
What is Fuchsia?           | An open source effort to create a production-grade operating system
What is FIDL?              | Fuchsia Interface Definition Language
Getting Started            | Download the Fuchsia source code

Generated HTML

<table>
  <thead>
    <tr>
      <th>Lesson</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>What is Fuchsia?</td>
      <td>An open source effort to create a production-grade operating system</td>
    </tr>
    <tr>
      <td>What is FIDL?</td>
      <td>Fuchsia Interface Definition Language</td>
    </tr>
    <tr>
      <td>Getting Started</td>
      <td>Download the Fuchsia source code</td>
    </tr>
  </tbody>
</table>

Rendered

Lesson Description
What is Fuchsia? An open source effort to create a production-grade operating system
What is FIDL? Fuchsia Interface Definition Language
Getting Started Download the Fuchsia source code

Formatting text in a table

You can use Markdown syntax to format text within a table (that is, *emphasis*, **strong**, `code`). To align text within a column, add a colon : in the dash --- row to indicate direction (that is, left, center, right) as in the example below:

Markdown

Left-aligned     | Center-aligned | Right-aligned
:---             |     :---:      |          ---:
info             | info           | info
more info        | more info      | more info
even *more* info | some `code`    | **not** code

Rendered

Left-aligned Center-aligned Right-aligned
info info info
more info more info more info
even more info some code not code