Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 1.34 KB

README.md

File metadata and controls

21 lines (16 loc) · 1.34 KB

regen-registry-program-guide (WIP Readme)

This readme should be more fully upated prior to marking this PR as open.

Overview of AsciiDoc

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 tables
  • http://foo.bar[My website] for rendering links
  • Term:: for definitions & term descriptions
  • <<Section Title>> for links between different sections