@antora/asciidoc-loader

Loads AsciiDoc content into an Asciidoctor Document object (AST) for use in an Antora documentation pipeline.

Stats

StarsIssuesVersionUpdatedCreatedSize
@antora/asciidoc-loader
3.0.16 months ago4 years agoMinified + gzip package size for @antora/asciidoc-loader in KB

Readme

Antora AsciiDoc Loader

The AsciiDoc Loader is a reusable library for handling AsciiDoc content in Antora. It loads AsciiDoc content into an AsciiDoc Document object (AST) for use in an Antora documentation pipeline.

The AsciiDoc loader wraps Asciidoctor.js and adds several extensions that enable AsciiDoc to work in an Antora environment. These extensions include:

  • An include processor that resolves files from the content catalog.
  • A cross reference converter that resolves references between pages based on Antora's page reference system.
  • Automatic resolution of paths to images and attachments.
  • Implicit document attributes that pass information from the Antora environment.

Antora is a modular static site generator designed for creating documentation sites from AsciiDoc documents. Its site generator aggregates documents from versioned content repositories and processes them using Asciidoctor.

Copyright and License

Copyright (C) 2017-present OpenDevise Inc. and the Antora Project.

Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.