Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/markdownライブラリ > RDoc::Markdownクラス

class RDoc::Markdown

クラス・モジュールの継承リスト: RDoc::Markdown < Object < Kernel < BasicObject

要約

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

特異メソッド

定義	説明
`extension(name) -> nil`	引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定義します。
`new(extensions = DEFAULT_EXTENSIONS, debug = false)`	引数 extensions で与えられた拡張を有効にした RDoc::Markdown オブジェクトを初期化します。
`parse(markdown) -> RDoc::Markup::Document`	引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

インスタンスメソッド

定義	説明
`break_on_newline -> bool`	改行を保持した状態で出力するかどうかを返します。
`break_on_newline=(val)`	改行を保持した状態で出力するかどうかを設定します。
`css -> bool`	CSS を記述した場合に出力に含めるかどうかを返します。
`css=(val)`	CSS を記述した場合に出力に含めるかどうかを設定します。
`definition_lists -> bool`	定義リストを解釈するかどうかを返します。
`definition_lists=(val)`	定義リストを解釈するかどうかを設定します。
`extension(name, enable) -> ()`	引数 name で指定した拡張の有効/無効を設定します。
`extension?(name)`	引数 name で指定した拡張が有効かどうかを返します。
`github -> bool`	Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返します。
`github=(val)`	Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを設定します。
`html -> bool`	HTML を記述した場合にそのまま出力するかどうかを返します。
`html=(val)`	HTML を記述した場合にそのまま出力するかどうかを設定します。
`notes -> bool`	脚注の出力を有効にするかどうかを返します。
`notes=(val)`	脚注の出力を有効にするかどうかを設定します。
`parse(markdown) -> RDoc::Markup::Document`	引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。

定数

定義	説明
`DEFAULT_EXTENSIONS -> [Symbol]`	デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
`EXTENSIONS -> [Symbol]`	サポートする拡張の一覧を Symbol の配列で返します。

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE

追加されるメソッド

定義	説明	ライブラリ
`HTML_ENTITIES -> {String => [Integer]}`	HTML の実体参照のマッピングを表す Hash オブジェクトです。 RDoc::Markdown で使用します。	rdoc/markdown/entities