/asciidoctor-sail

Sail Asciidoctor plugin

Primary LanguageRubyMIT LicenseMIT

Sail Asciidoctor Plugin

An Asciidoctor extension for including code from Sail ISA specifications into Asciidoc documents, primarily aimed at supporting documentation for RISC-V extensions using the sail-riscv model.

Installation

asciidoctor-sail is published on rubygems, so it can be installed with gem install:

gem install asciidoctor-sail

The requirements are simply asciidoctor itself, or asciidoctor and asciidoctor-diagram if encoding diagrams are generated (which also require the WaveDrom editor to be installed). asciidoctor-pdf is also supported for PDF generation.

Documentation

Documentation is available as a PDF here. The PDF is itself built with asciidoctor-pdf and asciidoctor-sail, using the various examples in doc/examples.