diff options
| author | Burdette Lamar <[email protected]> | 2024-07-29 08:16:13 -0500 |
|---|---|---|
| committer | git <[email protected]> | 2024-07-29 13:16:18 +0000 |
| commit | 63bdf2d72591c82e596320eb902579e0b93b0640 (patch) | |
| tree | c8656d8cb6e6d95b5f12b6f7a554ea85477d634d /lib/rdoc/markup.rb | |
| parent | df1cc043017660156c9d7477e5799de803573a80 (diff) | |
[ruby/rdoc] [DOC] Mods about markup formats
(https://github.com/ruby/rdoc/pull/1143)
https://github.com/ruby/rdoc/commit/011de3f2fd
Diffstat (limited to 'lib/rdoc/markup.rb')
| -rw-r--r-- | lib/rdoc/markup.rb | 31 |
1 files changed, 18 insertions, 13 deletions
diff --git a/lib/rdoc/markup.rb b/lib/rdoc/markup.rb index 6e93030965..3c29870d8a 100644 --- a/lib/rdoc/markup.rb +++ b/lib/rdoc/markup.rb @@ -10,19 +10,24 @@ # RDoc::Markup and other markup formats do no output formatting, this is # handled by the RDoc::Markup::Formatter subclasses. # -# = Supported Formats -# -# Besides the RDoc::Markup format, the following formats are built in to RDoc: -# -# markdown:: -# The markdown format as described by -# http://daringfireball.net/projects/markdown/. See RDoc::Markdown for -# details on the parser and supported extensions. -# rd:: -# The rdtool format. See RDoc::RD for details on the parser and format. -# tomdoc:: -# The TomDoc format as described by http://tomdoc.org/. See RDoc::TomDoc -# for details on the parser and supported extensions. +# = Markup Formats +# +# +RDoc+ supports these markup formats: +# +# - +rdoc+: +# the +RDoc+ markup format; +# see RDoc::MarkupReference. +# - +markdown+: +# The +markdown+ markup format as described in +# the {Markdown Guide}[https://www.markdownguide.org]; +# see RDoc::Markdown. +# - +rd+: +# the +rd+ markup format format; +# see RDoc::RD. +# - +tomdoc+: +# the TomDoc format as described in +# {TomDoc for Ruby}[http://tomdoc.org]; +# see RDoc::TomDoc. # # You can choose a markup format using the following methods: # |