Ruby Markdown類用法及代碼示例

RDoc::Markdown 如 markdown syntax 所述。

選擇Markdown作為您唯一的默認格式，請參見RDoc::Options 中保存的選項有關設置的說明.doc_options文件來存儲您的項目默認值。

用法

這是使用此解析手動讀取降價文件的簡短示例。

data = File.read("README.md")
formatter = RDoc::Markup::ToHtml.new(RDoc::Options.new, nil)
html = RDoc::Markdown.parse(data).accept(formatter)

# do something with html

擴展

解析器支持以下 markdown 擴展，但並非所有擴展都默認用於 RDoc 輸出。

RDoc

RDoc Markdown 解析器具有以下無法禁用的內置行為。

嵌入在單詞中的下劃線永遠不會被解釋為強調。 (雖然 markdown dingus 強調 in-word 下劃線，但 Markdown 語法和 MarkdownTest 均未提及此行為。)

對於 HTML 輸出， RDoc 總是 auto-links 裸 URL。

換行符

break_on_newline 擴展將所有換行符轉換為硬換行符，如 Github Flavored Markdown 。默認情況下禁用此擴展程序。

CSS

css 擴展允許 CSS 塊包含在輸出中，但它們不用於任何內置的 RDoc 輸出格式。默認情況下禁用此擴展程序。

例子：

<style type="text/css">
h1 { font-size: 3em }
</style>

定義列表

definition_lists 擴展允許使用 PHP Markdown Extra syntax 的定義列表，但目前僅支持一個標簽和定義。默認情況下啟用此擴展。

例子：

cat
:   A small furry mammal
that seems to sleep a lot

ant
:   A little insect that is known
to enjoy picnics

產生：

cat

一種毛茸茸的小哺乳動物，似乎經常睡覺

螞蟻

一種以喜歡野餐著稱的小昆蟲

罷工

例子：

This is ~~striked~~.

產生：

這是~擊中~。

Github

github 擴展啟用部分 Github Flavored Markdown 集。默認情況下啟用此擴展。

支持的 github 擴展包括：

圍欄代碼塊

在代碼塊周圍使用```，而不是縮進四個空格。

語法高亮

使用``` ruby 作為代碼圍欄的開始以添加語法高亮。 (目前僅支持ruby 語法)。

HTML

允許將原始 HTML 包含在輸出中。默認情況下啟用此擴展。

例子：

<table>
...
</table>

注意

notes 擴展支持腳注。默認情況下啟用此擴展。

例子：

Here is some text[^1] including an inline footnote ^[for short footnotes]

...

[^1]: With the footnote text down at the bottom

產生：

這是一些文本1，包括內聯腳注2

限製

• 不使用鏈接標題

• 腳注折疊成一個段落