Generating Rich Website Content with Asciidoc

[practicalli-johnny]

Static Site generators like Cryogen are uncomplex tools to create content for websites and tutorial.

Using asciidoc (rather than markdow) can potentially generate richer HTML code from asciidoc, facilitating the use of CSS frameworks by decorating the HTML structure with appropriate class names

e.g. include anchor points and add heading styles from a CSS framework

Generator rules can be defined (to be researched) for generating richer HTML code from asciidoc

Cryogen customisation

• Cryogen - post process article content with selma
• cryogen-asciidoc project

Bulma CSS

a friendly CSS library used by several Practicalli projects

• Bulma.io - anchors

Asciidoctor

There is a Java and JavaScript implementation of Asciidoctor (and maybe other implemetations)

Cryogen uses the Java implementation under the covers

• Asciidoc tooling
• Asciidoctor attributes
• https://docs.asciidoctor.org/
• Asciidoctor interface
• AsciidoctorJ - getting started
• Asciidoctor converter templates
• Asciidoctor - set converter template directory
• Asciidoctor github issue - how to convert html/css output
• https://www.tabnine.com/code/java/methods/org.asciidoctor.Asciidoctor/convert
• Asciidoctor: Write a custom converter
• Asciidoctor.js - custom converter - docs.asciidotor.org
• Asciidoctor.js - write your own converter
• Write test publish AsciidocJ extension

Code examples

• Asciidoctor options
• asciidoctorJ html5 converter
• asciidoctorj pages

Related projects

• flexmark-java - CommonMark/Markdown Java parser with source level AST
• ascidoclj - 8 year old project

General resources

• https://docs.asciidoctor.org/asciidoc/latest/asciidoc-vs-markdown/
• https://docs.netapp.com/us-en/contribute/asciidoc_syntax.html
• https://docs.asciidoctor.org/