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

Documentation

Specifications

During reverse engineering the AsciiDoc markup, we write the syntax, rules, and format in this document.

Features

List of available formatting that are supported on current implementation. Each supported feature is linked to official AsciiDoc Language Documentation. The numbered one is based on the old documentation.

  • Document header

  • 15. Preamble

  • 16. 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

  • 17. Blocks

    • 17.1. Title

    • 17.2. Metadata

    • 17.3. Delimited blocks

  • 18. Paragraph

    • 18.1. Alignment

    • 18.2. Line breaks (" +n")

    • 18.3. Lead style

  • 19. Text formatting

    • 19.1. Bold and italic

    • 19.2. Quotation Marks and Apostrophes

    • 19.3. Subscript and Superscript

    • 19.4. Monospace

  • 20. Unordered Lists

    • 20.1. Nested

    • 20.2. Complex List Content

    • 20.3. Custom Markers

    • 20.4. Checklist

  • 21. Ordered Lists

    • 21.1. Nested

    • 21.2. Numbering Styles

  • 22. Description List

    • 22.1. Question and Answer Style List

  • 23. 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

  • 24. Horizontal Rules

    • 24.1. Markdown-style horizontal rules

  • 25. Page Break

  • 26. URLs

    • 26.1. Link to Relative Files

  • 27. Cross References

    • 27.1. Automatic Anchors

    • 27.2. Defining an Anchor

    • 27.3. Internal Cross References

    • 27.5. Customizing the Cross Reference Text

  • Footnotes

  • 28. Include Directive

    • 28.1. Anatomy

    • 28.2. Processing

    • 28.3. File resolution

  • 29. Images

  • 30. Video

    • 30.1. YouTube and Vimeo videos

    • 30.2. Supported Attributes

  • 31. Audio

  • 32. Admonition

  • 33. Sidebar

  • 34. Example

  • 35. Prose Excerpts, Quotes and Verses

    • 35.1. Quote

    • 35.2. Verse

  • 36. Comments

  • 37. Text Substitutions

    • 37.1. Special Characters

    • 37.2. Quotes

    • 37.3. Attributes (reference)

    • 37.4. Replacements

    • 37.9. Preventing Substitutions

  • 39. Listing Blocks

  • 40. Passthroughs

    • 40.2. Passthrough Blocks

  • 41. 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

Additional metadata provides by this library,

  • author_names - list of author full names separated by comma.

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

  • 14. Header

    • 14.4. Subtitle partitioning. Rationale: duplicate with 14.1.2 the "Main: sub" format

  • 23. Tables

    • 23.10. Nested tables. Rationale: nested table is not a good way to present information. Never should it be.

    • Using different cell separator

  • 28. 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

TODO

List of features which may be implemented,

  • 16. Sections

    • 16.9. Section styles

  • 18. Paragraph

    • 18.2. Line breaks

      • Per block "[%hardbreaks]"

      • All document ":hardbreaks:"

  • 19. Text formatting

    • 19.5. Custom Styling With Attributes

  • 23. Tables

    • 23.13. Delimiter-Separated Values

  • 27. Cross References

    • 27.6. Inter-document Cross References

  • 28. 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

  • 37. Text Substitutions

    • 37.5. Macros

    • 37.8. Incremental Substitutions

  • 40. Passthroughs

    • 40.1. Passthrough Macros

BUGS

Unknown.

ENHANCEMENTS

  • Create tree that link Include directive. Once the included files changes, the parent should be rendered too.

    Include Node
    parent -> Parent Node.

Miscellaneous

The following files compare the HTML generated by asciidoctor and this library:

Development

Repository

Link to the source code.

Mailing list

Link to discussion or where to send the patches.

Issues

Link to open an issue or request for new feature.