Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@antora/asciidoc-loader

2.3.3 • Public • Published

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 pipeline aggregates documents from versioned content repositories and processes them using Asciidoctor.

Copyright and License

Copyright (C) 2017-2020 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).

Install

npm i @antora/asciidoc-loader

DownloadsWeekly Downloads

4,712

Version

2.3.3

License

MPL-2.0

Unpacked Size

49.9 kB

Total Files

15

Homepage

antora.org

Last publish

Collaborators

  • avatar
  • avatar