asciidoctor

asciidoctor-go

Shulhan ms@kilabit.info

The asciidoctor-go is the Go module to parse the AsciiDoc markup and convert it into HTML5.

Features

List of available formatting that are supported on current implementation, numbered based on AsciiDoc user manual,

• 1. Header
  • 14.1. Document title
    • 14.1.1. doctitle attribute
    • 14.1.2. Document subtitle
    • 14.1.3. Document title visibility
  • 14.2. Author and email
  • 14.3. Revision number, date
  • 14.5. Metadata
    • 14.5.1. Description
    • 14.5.2. Keywords
• 1. Preamble
• 1. Sections
  • 16.1. Titles as HTML headings
  • 16.2. Auto-generated IDs
  • 16.3. Custom IDs
  • 16.4. Multiple Anchors
  • 16.5. Links
  • 16.6. Anchors
  • 16.7. Numbering
  • 16.8. Discrete headings
• 1. Blocks
  • 17.1. Title
  • 17.2. Metadata
  • 17.3. Delimited blocks
• 1. Paragraph
  • 18.1. Alignment
  • 18.2. Line breaks (" +\n")
  • 18.3. Lead style
• 1. Text formatting
  • 19.1. Bold and italic
  • 19.2. Quotation Marks and Apostrophes
  • 19.3. Subscript and Superscript
  • 19.4. Monospace
• 1. Unordered Lists
  • 20.1. Nested
  • 20.2. Complex List Content
  • 20.3. Custom Markers
  • 20.4. Checklist
• 1. Ordered Lists
  • 21.1. Nested
  • 21.2. Numbering Styles
• 1. Description List
  • 22.1. Question and Answer Style List
• 1. Tables
  • 23.1. Columns
  • 23.2. Column formatting
  • 23.3. Cell formatting
  • 23.4. Header row
  • 23.5. Footer row
  • 23.6. Table width
  • 23.7. Table borders
  • 24.8. Striping
  • 24.9. Orientation
  • 24.10. Nested tables
  • 24.11. Table caption
  • 24.12. Escaping the Cell Separator
• 1. Horizontal Rules
  • 24.1. Markdown-style horizontal rules
• 1. Page Break
• 1. URLs
  • 26.1. Link to Relative Files
• 1. Cross References
  • 27.1. Automatic Anchors
  • 27.2. Defining an Anchor
  • 27.3. Internal Cross References
  • 27.5. Customizing the Cross Reference Text
• 1. Include Directive
  • 28.1. Anatomy
  • 28.2. Processing
  • 28.3. File resolution
• 1. Images
• 1. Video
  • 30.1. YouTube and Vimeo videos
  • 30.2. Supported Attributes
• 1. Audio
• 1. Admonition
• 1. Sidebar
• 1. Example
• 1. Prose Excerpts, Quotes and Verses
  • 35.1. Quote
  • 35.2. Verse
• 1. Comments
• 1. Text Substitutions
  • 37.1. Special Characters
  • 37.2. Quotes
  • 37.3. Attributes (reference)
  • 37.4. Replacements
  • 37.9. Preventing Substitutions
• 1. Listing Blocks
• 1. Passthroughs
  • 40.2. Passthrough Blocks
• 1. Open Blocks
• A.3. Predefined Attributes for Character Replacements

Supported metadata or attribute references,

• author(_x)
• authorinitials(_x)
• doctitle
• email(_x)
• firstname(_x)
• idprefix
• idseparator
• lastname(_x)
• middlename(_x)
• nofooter
• noheader
• revdate
• revnumber
• revremark
• sectids
• sectnumlevels
• sectnums
• showtitle
• table-caption
• title-separator
• version-label

TODO

List of features which will be implemented,

• 1. Sections
  • 16.9. Section styles
• 1. Paragraph
  • 18.2. Line breaks
    • Per block "[%hardbreaks]"
    • All document ":hardbreaks:"
• 1. Text formatting
  • 19.5. Custom Styling With Attributes
• 1. Tables
  • 23.13. Delimiter-Separated Values
• 1. Cross References
  • 27.6. Inter-document Cross References
• 1. Include Directive
  • 28.4. Partitioning large documents and using leveloffset
  • 28.5. AsciiDoc vs non-AsciiDoc files
  • 28.7. Normalize Block Indentation
  • 28.10. Include a File Multiple Times in the Same Document
  • 28.11. Using an Include in a List Item
• 1. Text Substitutions
  • 37.5. Macros
  • 37.8. Incremental Substitutions
• 1. Passthroughs
  • 40.1. Passthrough Macros

Not supported

The following markup will not supported because its functionality is duplicate with others markup or not secure,

• 1. Header
  • 14.4. Subtitle partitioning. Rationale: duplicate with 14.1.2 the "Main: sub" format
• 1. Tables
  • 23.10. Nested tables. Rationale: nested table is not a good way to present information. Never should it be.
  • Using different cell separator
• 1. Include Directive
  • 28.6. Select Portions of a Document to Include. Rationale: the parser would need to know the language to be included and parse the whole source code to check for comments and tags.
  • 28.8. Include Content from a URI. Rationale: security and unreliable network connections.
  • 28.9. Caching URI Content