mlippens / asciidoctor-example

Sample gradle configuration with asciidoctor

Advanced asciidoctor with gradle example

This config has a CSS that auto toggles to dark or light them on browsers that honor the prefers-color-scheme: dark CSS directive.

Screenshots

This configuration is based on HighlightJS which was easier to tweak with the CSS, hence it’s CSS is also set-up to switch styles accordingly.

---

Links and discussion that helped me

docs and blogs

• Asciidoctor manual

• https://asciidoctor.github.io/asciidoctor-gradle-plugin/development-2.0/

• Awesome Asciidoctor: Use Inline Icons

• PlantUML Doc 0.2.01 documentation

• AsciiDoc & doc-as-code Best Practices

• Auto dark mode in CSS

• highlight.js integration guide

• highlight.js

• Produce Custom Themes Using the Asciidoctor Stylesheet Factory

• Changing Highlight.js Theme

• collapsible toc

• Collapsible content (asciidoctor 2, need gradle plugin 3.x)

• no wrapping

• Support non regular highlight.js languages

git repository

• https://github.com/asciidoctor/asciidoctor-gradle-plugin

• Removing module access warning post Java 9

• Provide access to the sourceDir value as attribute

• Asciidoctor attributes

• Asciidoctor diagram

• Tracking AsciidoctorJ 2.0.0 integration

• A sample AsciiDoc file for testing Asciidoctor

challenges

• Asciidoctor Admonition Icons Missing

  Actually, it’s even simpler than that! Asciidoctor comes integrated with Font Awesome out of the box. You just need to remove the blank line between the document title & the font attribute entry.

  The font attribute entry must be part of the document header, which is offset from the body by a blank line.

• Overriding stylesdir value in per-file attributes

• Single CSS for multiple, nested adoc files