別のキーワード
種類
- インスタンスメソッド (8)
- 特異メソッド (2)
- 定数 (2)
- ライブラリ (1)
ライブラリ
-
rdoc
/ markdown (12)
クラス
-
RDoc
:: Markdown (12)
キーワード
-
DEFAULT
_ EXTENSIONS (1) - EXTENSIONS (1)
-
break
_ on _ newline (1) - css (1)
-
definition
_ lists (1) - extension (2)
- github (1)
- html (1)
- notes (1)
- parse (2)
検索結果
先頭5件
-
rdoc
/ markdown (114109.0) -
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための サブライブラリです。
Markdown 形式で記述されたドキュメントを rdoc 上で解析するための
サブライブラリです。
詳しくは以下を参照してください。
* https://daringfireball.net/projects/markdown/syntax
Markdown 形式をデフォルトのフォーマットにする場合は、
lib:rdoc#saved_options を参考に プロジェクトのデフォルトを
.rdoc_options ファイルで設定してください。
=== 拡張
以降の Markdown の拡張は RDoc のパーサ独自にサポートされているも
のです。ただし、全てがデフォルトで有効にな... -
RDoc
:: Markdown # break _ on _ newline -> bool (24301.0) -
改行を保持した状態で出力するかどうかを返します。
改行を保持した状態で出力するかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # css -> bool (24301.0) -
CSS を記述した場合に出力に含めるかどうかを返します。
CSS を記述した場合に出力に含めるかどうかを返します。
デフォルトでは false を返します。 -
RDoc
:: Markdown # definition _ lists -> bool (24301.0) -
定義リストを解釈するかどうかを返します。
定義リストを解釈するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # extension(name , enable) -> () (24301.0) -
引数 name で指定した拡張の有効/無効を設定します。
引数 name で指定した拡張の有効/無効を設定します。
@param name 拡張の名前を Symbol で指定します。
@param enable 有効にする場合は true を、無効にする場合は false を指定し
ます。 -
RDoc
:: Markdown # github -> bool (24301.0) -
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し ます。
Github Flavored Markdown 拡張の一部を有効にして出力を行うかどうかを返し
ます。
デフォルトでは true を返します。 -
RDoc
:: Markdown # html -> bool (24301.0) -
HTML を記述した場合にそのまま出力するかどうかを返します。
HTML を記述した場合にそのまま出力するかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # notes -> bool (24301.0) -
脚注の出力を有効にするかどうかを返します。
脚注の出力を有効にするかどうかを返します。
デフォルトでは true を返します。 -
RDoc
:: Markdown # parse(markdown) -> RDoc :: Markup :: Document (24301.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Markdown . extension(name) -> nil (24301.0) -
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定 義します。
引数 name で指定した拡張を有効/無効にするためのインスタンスメソッドを定
義します。
ライブラリ内部で使用します。 -
RDoc
:: Markdown . parse(markdown) -> RDoc :: Markup :: Document (24301.0) -
引数 markdown で指定したドキュメントを解析して RDoc::Markup::Document オブジェクトを返します。
引数 markdown で指定したドキュメントを解析して
RDoc::Markup::Document オブジェクトを返します。
@param markdown 解析の対象になるドキュメントを文字列で指定します。 -
RDoc
:: Markdown :: DEFAULT _ EXTENSIONS -> [Symbol] (24301.0) -
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。
デフォルトで有効になっている拡張の一覧を Symbol の配列で返します。 -
RDoc
:: Markdown :: EXTENSIONS -> [Symbol] (24301.0) -
サポートする拡張の一覧を Symbol の配列で返します。
サポートする拡張の一覧を Symbol の配列で返します。