asciidoctorjs-user-manual.adoc

Asciidoctor.js User Manual

• Install

• Usage

  • How to integrate into a Node.js app, a web page, an Atom plugin, a Brackets plugin, a Nashorn app, a JavaScript app bundled with Webpack…​

  • How to instantiate the Asciidoctor processor

• Basic API

  • load()

  • convert()

  • Options and attributes

• Include macro and reading files limitations

  • Current limitations

    • base_dir, get content from URI synchronously in Node.js, File.readFileSync on URI…​

  • Safe mode

  • allow-uri-read option

• AST (Document, Node) API

• Extensions API

  • Extension points

  • Register

  • Examples

• Rich content

  • Diagram

  • STEM

  • Fontawesome

  • Code highlighting

  • …​

• Customize output

  • stylesheets

  • write a converter

    • Node type: document, embedded, section, outline…​

  • custom converter in JavaScript

  • custom converter using Pug/Jade templates

  • custom converter in Ruby (then compiled to JavaScript)

  • custom converter using Slim templates (then compiled to JavaScript)

• Tools using Asccidoctor.js / Ecosystem

  • Browser extension

  • Atom

  • Brackets

  • Reveal.js converter

  • Bespoke converter ?

  • Antora

  • GitBook

  • …​