class RDoc::Markdown

要約

Markdown 形式で記述されたドキュメントを rdoc 上で解析するためのクラスです。

目次

特異メソッド
インスタンスメソッド
定数

特異メソッド

extension(name) -> nil[permalink][rdoc]

引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定義します。

ライブラリ内部で使用します。

new(extensions = DEFAULT_EXTENSIONS, debug = false)[permalink][rdoc]

引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブジェクトを初期化します。

[PARAM] extensions:
有効にする拡張を Symbol の配列で指定します。
[PARAM] debug:
デバッグを有効にするかどうかを指定します。
parse(markdown) -> RDoc::Markup::Document[permalink][rdoc]

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

[PARAM] markdown:
解析の対象になるドキュメントを文字列で指定します。

インスタンスメソッド

break_on_newline -> bool[permalink][rdoc]

改行を保持した状態で出力するかどうかを返します。

デフォルトでは false を返します。

break_on_newline=(val)[permalink][rdoc]

改行を保持した状態で出力するかどうかを設定します。

css -> bool[permalink][rdoc]

CSS を記述した場合に出力に含めるかどうかを返します。

デフォルトでは false を返します。

css=(val)[permalink][rdoc]

CSS を記述した場合に出力に含めるかどうかを設定します。

definition_lists -> bool[permalink][rdoc]

定義リストを解釈するかどうかを返します。

デフォルトでは true を返します。

definition_lists=(val)[permalink][rdoc]

定義リストを解釈するかどうかを設定します。

extension(name, enable) -> ()[permalink][rdoc]

引数 name で指定した拡張の有効/無効を設定します。

[PARAM] name:
拡張の名前を Symbol で指定します。
[PARAM] enable:
有効にする場合は true を、無効にする場合は false を指定します。
extension?(name)[permalink][rdoc]

引数 name で指定した拡張が有効かどうかを返します。

[PARAM] name:
拡張の名前を Symbol で指定します。
github -> bool[permalink][rdoc]

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返します。

デフォルトでは true を返します。

github=(val)[permalink][rdoc]

Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定します。

html -> bool[permalink][rdoc]

HTML を記述した場合にそのまま出力するかどうかを返します。

デフォルトでは true を返します。

html=(val)[permalink][rdoc]

HTML を記述した場合にそのまま出力するかどうかを設定します。

notes -> bool[permalink][rdoc]

脚注の出力を有効にするかどうかを返します。

デフォルトでは true を返します。

notes=(val)[permalink][rdoc]

脚注の出力を有効にするかどうかを設定します。

parse(markdown) -> RDoc::Markup::Document[permalink][rdoc]

引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

[PARAM] markdown:
解析の対象になるドキュメントを文字列で指定します。

定数

DEFAULT_EXTENSIONS -> [Symbol][permalink][rdoc]

デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。

EXTENSIONS -> [Symbol][permalink][rdoc]

サポートする拡張の一覧を Symbol の配列で返します。