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 2.0.0-canary.19 or newer.

• 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 asciidocAttributes.author

npm install eleventy-plugin-asciidoc

Usually eleventy.config.js or .eleventy.js:

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

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

You can use either Eleventy style front matter or AsciiDoc document attributes to write front matter.

Any AsciiDoc document attributes that are prefixed with eleventy- (configurable) can be used as front matter. The prefix, eleventy-, will be removed from variable names available in the templates.

Only document-scoped attributes or variables can be used for front matter. Attributes that are written after the document title (= Document Title) will not be considered for front matter.

:eleventy-permalink: /hello-world/
:eleventy-layout: base.njk

= Hello World

Hello everyone!

The above AsciiDoc attribute front matter is the same as YAML based front matter below:

---
permalink: /hello-world/
layout: base.njk
---

= Hello World

Hello everyone!

Data specified using AsciiDoc style front matter override YAML (or front matter in other Eleventy supported formats).

---
layout: layout-a.njk
---
:eleventy-layout: layout-b.njk

= Hello World

Hello everyone!

In the above case, front matter data will have { layout: layout-b.njk }.

In the case of title, the AsciiDoc document title (including title and doctitle attributes) takes precedence over front matter.

You can pass options as the second argument in addPlugin().

Default value is eleventy-.

This config can be used to change the prefix string for AsciiDoc style front matter.

Default value is false.

If enabled, the title will be resolved from the heading of the first section in the document. Otherwise, the title will be the Level 0 heading.

== A second level heading

This text is written in AsciiDoc format.

With resolveDocumentTitle: true, the above document will have a title (in page data). A second level heading.

All properties other than the ones specific to the plugin will be passed to Asciidoctor.js.

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 */,
  });
};

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

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

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.

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.

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.

• Tutorial on adding syntax highlighting