This readme should be more fully upated prior to marking this PR as open.
AsciiDoc is a lightweight and semantic markup language primarily designed for writing technical documentation. The language can be used to produce a variety of presentation-rich output formats, all from content encoded in a concise, human-readable, plain text format.
In the context of the Regen Registry Program Guide, we use a small subset of the features of AsciiDoc, which are documented here:
=
,==
for headings & subheadings:sectnums:
and:sectnumlevels:
to enable decimal-outline notation for section headings:toc:
to auto-generate a table of contents.
,..
for ordered lists-
,*
for un-ordered lists- indentation of ordered & unordered lists do not affect rendering, and are done only to make the plain-text easier to read
footnote:
keyword is used to generate footnotes|===
to create basic tableshttp://foo.bar[My website]
for rendering linksTerm::
for definitions & term descriptions<<Section Title>>
for links between different sections