eleventy-plugin-asciidoc 1.0.0

package/.eleventy.js

@@ -0,0 +1,13 @@
+const eleventyAsciidoc = require("./lib/eleventy-asciidoc.js");
+
+module.exports = {
+  /**
+   * Plugin config function
+   *
+   * @param      {Object}  eleventy     The eleventy configuration object
+   */
+  configFunction(eleventyConfig, userOptions) {
+    eleventyConfig.addTemplateFormats("adoc");
+    eleventyConfig.addExtension("adoc", eleventyAsciidoc(userOptions));
+  },
+};

package/.gitattributes

@@ -0,0 +1 @@
+*.js text eol=lf

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Saneef Ansari
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# eleventy-plugin-asciidoc
+
+Eleventy plugin to add support for AsciiDoc. The plugin uses [Asciidoctor.js](https://docs.asciidoctor.org/asciidoctor.js) under the hood.
+
+**Requires Eleventy `1.0.0` or newer.**
+
+## Usage
+
+### Install
+
+```sh
+npm install eleventy-plugin-asciidoc
+```
+
+### Add to Configuration File
+
+Usually `.eleventy.js`:
+
+```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](https://docs.asciidoctor.org/asciidoctor.js/latest/processor/convert-options/).
+
+```js
+const eleventyAsciidoc = require("eleventy-plugin-asciidoc");
+
+module.exports = function (eleventyConfig) {
+  eleventyConfig.addPlugin(eleventyAsciidoc, {
+    /* Converter options */
+    showtitle: true,
+    safe: "unsafe",
+  });
+};
+```

package/lib/eleventy-asciidoc.js

@@ -0,0 +1,47 @@
+// @ts-check
+
+const asciidoctor = require("asciidoctor").default();
+const debug = require("debug")("eleventy-asciidoc");
+
+const nunjucks = require("nunjucks");
+const fs = require("fs");
+const matter = require("gray-matter");
+
+function eleventyAsciidoctor(options = {}) {
+  debug("Options: ", options);
+  const readFileSync = (inputPath) => {
+    return matter(fs.readFileSync(inputPath, "utf8"));
+  };
+
+  const getData = (inputPath) => {
+    const { data } = readFileSync(inputPath);
+
+    return data;
+  };
+
+  const compile = (str) => (data) => {
+    if (str) {
+      // Since `read: false` is set 11ty doesn't read file contents
+      // so if str has a value, it's a permalink (which can be a string or a function)
+      return typeof str === "function"
+        ? str(data)
+        : nunjucks.renderString(str, data);
+    }
+
+    debug(`Reading ${data.page.inputPath}`);
+    const { content } = readFileSync(data.page.inputPath);
+
+    if (content) {
+      debug(`Converting:\n ${content}`);
+      return asciidoctor.convert(content, options);
+    }
+  };
+
+  return {
+    read: false,
+    getData,
+    compile,
+  };
+}
+
+module.exports = eleventyAsciidoctor;

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "eleventy-plugin-asciidoc",
+  "version": "1.0.0",
+  "description": "Adds support for AsciiDoc to Eleventy",
+  "main": ".eleventy.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com:saneef/eleventy-plugin-asciidoctor.git"
+  },
+  "scripts": {
+    "lint": "eslint lib/**.js tests/**.js",
+    "test": "nyc ava --timeout=1m -v --color",
+    "prepare": "husky install"
+  },
+  "keywords": [
+    "responsive-images",
+    "images",
+    "eleventy",
+    "11ty",
+    "eleventy-plugin"
+  ],
+  "author": "Saneef Ansari <hello@saneef.com> (https://saneef.com/)",
+  "license": "MIT",
+  "dependencies": {
+    "asciidoctor": "^2.2.5",
+    "debug": "^4.3.2",
+    "gray-matter": "^4.0.3",
+    "nunjucks": "^3.2.3"
+  },
+  "devDependencies": {
+    "ava": "^3.15.0",
+    "eslint": "^8.0.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-xo-space": "^0.30.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.2",
+    "lint-staged": "^11.2.3",
+    "nyc": "^15.1.0",
+    "prettier": "^2.4.1",
+    "rimraf": "^3.0.2"
+  },
+  "lint-staged": {
+    "*.js": "eslint --cache --fix",
+    "*.{js,md,json}": "prettier --write"
+  },
+  "ava": {
+    "files": [
+      "tests/**/*",
+      "!tests/utils.js"
+    ],
+    "ignoredByWatcher": [
+      "tests/output/**"
+    ]
+  }
+}