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

限制

• 不使用链接标题

• 脚注折叠成一个段落