@11ty/eleventy-plugin-inclusive-language

An Eleventy linter plugin to check for inclusive language in markdown files.

Usage no npm install needed!

<script type="module">
  import 11tyEleventyPluginInclusiveLanguage from 'https://cdn.skypack.dev/@11ty/eleventy-plugin-inclusive-language';
</script>

README

eleventy-plugin-inclusive-language

An Eleventy linter plugin to check for inclusive language in markdown files. No browser/client JavaScript here, everything is this plugin is done at build-time.

Installation

Available on npm.

npm install @11ty/eleventy-plugin-inclusive-language --save

Open up your Eleventy config file (probably .eleventy.js) and use addPlugin:

const inclusiveLangPlugin = require("@11ty/eleventy-plugin-inclusive-language");
module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(inclusiveLangPlugin);
};

Read more about Eleventy plugins.

Options

Optionally pass in an options object as the second argument to addPlugin to further customize this plugin.

const syntaxHighlight = require("@11ty/eleventy-plugin-syntaxhighlight");
module.exports = function(eleventyConfig) {
  eleventyConfig.addPlugin(syntaxHighlight, {
    templateFormats: ["md"], // default, add more file extensions here

    // accepts an array or a comma-delimited string
    words: "simply,obviously,basically,of course,clearly,just,everyone knows,however,easy"
  });
};