class RDoc::Markdown (Ruby 3.3 リファレンスマニュアル)

要約

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

特異メソッド

extension(name) -> nilRuby 2.0.0 から[permalink][rdoc][edit]

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

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

new(extensions = DEFAULT_EXTENSIONS, debug = false)Ruby 2.0.0 から[permalink][rdoc][edit]

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

[PARAM] extensions:: 有効にする拡張を Symbol の配列で指定します。
[PARAM] debug:: デバッグを有効にするかどうかを指定します。

parse(markdown) -> RDoc::Markup::DocumentRuby 2.0.0 から[permalink][rdoc][edit]

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

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

インスタンスメソッド

break_on_newline -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

break_on_newline=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

css -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

css=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

definition_lists -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

definition_lists=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

extension(name, enable) -> ()Ruby 2.0.0 から[permalink][rdoc][edit]

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

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

extension?(name)Ruby 2.0.0 から[permalink][rdoc][edit]

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

[PARAM] name:: 拡張の名前を Symbol で指定します。

github -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

github=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

html -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

html=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

notes -> boolRuby 2.0.0 から[permalink][rdoc][edit]

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

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

notes=(val)Ruby 2.0.0 から[permalink][rdoc][edit]

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

parse(markdown) -> RDoc::Markup::DocumentRuby 2.0.0 から[permalink][rdoc][edit]

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

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

追加されるメソッド

HTML_ENTITIES -> {String => [Integer]}Ruby 2.0.0 から[permalink][rdoc][edit] [added by rdoc/markdown/entities]: HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。

定数

DEFAULT_EXTENSIONS -> [Symbol]Ruby 2.0.0 から[permalink][rdoc][edit]: デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
EXTENSIONS -> [Symbol]Ruby 2.0.0 から[permalink][rdoc][edit]: サポートする拡張の一覧を Symbol の配列で返します。

要約

目次

特異メソッド

インスタンスメソッド

追加されるメソッド

定数