Metalsmith plugin to transform Asciidoc files to HTML
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
package.json
yarn.lock

README.md

metalsmith-asciidoctor

npm version Build Status

Metalsmith plugin to transform AsciiDoc files to HTML using asciidoctor.js.

Installation

With npm:

npm install --save-dev metalsmith-asciidoctor

With yarn:

yarn add --dev metalsmith-asciidoctor

Usage

var asciidoctor = require("metalsmith-asciidoctor");

Metalsmith(__dirname)
  /* ... */
  .use(asciidoctor())
  /* ... */

By default, the plugin will process all .adoc files and render them to HTML. You can customize this default behavior by setting the pattern property on a configuration object.

.use(asciidoctor({
  pattern: "**/*.asciidoc"
}))

You can also pass custom options to the asciidoctor.js by setting the options property. Please note that this will also allow you to provide custom attributes.

.use(asciidoctor({
  options: {
    safe: "safe",
    attributes: {
      "note-caption": "Hinweis",
      "warning-caption": "Warnung"
    }
  }
}))

License

MIT