Ruby 2.5.0 リファレンスマニュアル > ライブラリ一覧 > rdoc/markupライブラリ

library rdoc/markup

要約

RDoc 形式に整形されたプレインテキストを変換するためのサブライブラリです。

RDoc::Markup は RDoc 形式のドキュメント、Wiki エントリ、Web上の FAQ などを想定したプレインテキストから様々なフォーマットへの変換を行う ツール群の基礎として作られています。RDoc::Markup 自身は何の出力も 行いません。 それらは 出力可能な形式 で後述するクラス群に委ねられています。

Markup

基本的には、rdoc/Markup と同じです。ただし、rdoc コマンドと は異なり、Ruby のソースコードのコメント部分ではなく、プレインテキストが 変換対象になります。そのため、以下のみがフォーマットされます。

出力可能な形式

変換する形式として以下のいずれかを選択できます。

クラス

RDoc::Markup

RDoc 形式のドキュメントを目的の形式に変換するためのクラスです。

サブライブラリ

rdoc/markup/formatter

RDoc 形式のドキュメントを整形するためのサブライブラリです。

rdoc/markup/to_ansi

RDoc 形式のドキュメントを ANSI エスケープシーケンスで色付けするサブライ ブラリです。

rdoc/markup/to_bs

RDoc 形式のドキュメントをエスケープシーケンスで太字やアンダーラインの効 果を持たせるように見せるサブライブラリです。

rdoc/markup/to_html

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

rdoc/markup/to_html_crossref

RDoc 形式のドキュメントを HTML に整形するためのサブライブラリです。

rdoc/markup/to_rdoc

RDoc 形式のドキュメントをマークアップ記法を保持したまま出力させるための サブライブラリです。