Ruby Document format
RD is a lightweight markup language
for writing Ruby-related documents.
It can be embedded in Ruby source code.
RD is a traditional format.
In modern Ruby, developers tend to write documents in RDoc instead of RD.
Use
Originally, most documentation in the Ruby world, including for Ruby itself, had been written in RD. Then in 2002, much of it was converted to RDoc format. Although, the Japanese version of the Ruby Reference Manual still remains in RD format.RD is designed to be written by hand and easily read in its raw form. Most end-users however experience it after it has been converted into HTML or man pages.
RD can be embedded in Ruby code, and pure RD files usually have the extension
.rd.Sample RD document
This document is syntactically correct RD,which attempts to follow the major conventions on section naming as well.
NAME
RD sample - A sample RD documentSYNOPSIS
here.is_a?
print <<"END"
This indented block will not be scanned for formatting
codes or directives, and spacing will be preserved.
END
DESCRIPTION
Here's some normal text. It includes text that isemphasized,,
code-formatted, variable part, indexed, and as-is*1.An Example List
- This is a bulleted list.
- Here's another item.
- * Nested list item.
An ordered List
- This is the first item
- second
include images, apply
styles, or do anything else I can do with
HTML. RD processors that aren't outputting HTML
will completely ignore it.