eleventy-plugin-asciidoc

3.1.2 • Public • Published

eleventy-plugin-asciidoc

Eleventy plugin to add support for AsciiDoc. You don't need to use to shortcodes. You can directly use AsciiDoc files (.adoc), just like Markdown (.md).

The plugin uses Asciidoctor.js under the hood.

Requires Eleventy 1.0.0-beta.10, 1.0.0-canary.50 or newer.

Features

  • Supports the default YAML front matter.
  • Supports AsciiDoc document title
  • Other attributes in the AsciiDoc files are made available in templates through asciidocAttributes.
    • Example :author: Jane Doe in the .adoc file will be available as asciidocAttrbutes.author

Usage

Install

npm install eleventy-plugin-asciidoc

Add to Configuration File

Usually .eleventy.js:

const eleventyAsciidoc = require("eleventy-plugin-asciidoc");

module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(eleventyAsciidoc);
};

Customize with Options

You can pass options to convert() of Asciidoctor.js as second argument in addPlugin(). These are the available options.

const eleventyAsciidoc = require("eleventy-plugin-asciidoc");

module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(eleventyAsciidoc, {
    attributes: {
      showtitle: true /* Default value: undefined */,
    },
    safe: "unsafe" /* Default value: undefined */,
  });
};

base_dir

The base_dir of convert options is relative to the document. This can be changed using the above options.

attributes.outdir

By default, attributes.outdir will be the path to the output directory (permalink) of the document. This can be changed using the above options.

extension_registry (⚠️ deprecated)

The convert option extension_registry will not work as intended from Asciidoctor.js v3.0 onwards. The extension_registry needs a newly created registry for each conversion. Use the configure_extension_registry function instead.

configure_extension_registry

The configure_extension_registry should be a function which accepts a registry (instance of Extensions.Registry). During each file conversion, the function will be called with a new registry. This registry instance can be used to register extensions.

const eleventyAsciidoc = require("eleventy-plugin-asciidoc");
const myExtension = require("./my-extension.js");

module.exports = function (eleventyConfig) {
  eleventyConfig.addPlugin(eleventyAsciidoc, {
    configure_extension_registry(registry) {
      myExtension.register(registry);
      // Or, myExtension(registry) depending on how
      // you have programmed your extension.
    },
  });
};

Refer to Asciidoctor.js documentation to know more about extensions.

CSS Styles

The plugin does not include any CSS styles. It is up to you to style the content.

The quickest way to style the content is to use the CSS file from Asciidoctor.js. The CSS file is available on cdnjs.

Enhancements

Package Sidebar

Install

npm i eleventy-plugin-asciidoc

Weekly Downloads

5

Version

3.1.2

License

MIT

Unpacked Size

11.9 kB

Total Files

7

Last publish

Collaborators

  • saneef