Skip to content
A plugin for the Eleventy static site generator for making your typography nicer.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.gitignore
.nvmrc
README.md
index.js
package-lock.json
package.json
typeset-plugin.js

README.md

Typeset plugin for Eleventy

A plugin for the Eleventy static site generator for making your typography nicer, based on Typeset.js.

Install

npm install --save eleventy-plugin-typeset

Usage

In your Eleventy config file (defaults to .eleventy.js):

const typesetPlugin = require('eleventy-plugin-typeset');

module.exports = (eleventyConfig) => {
  eleventyConfig.addPlugin(typesetPlugin());
};

Configuration

Typeset.js accepts a couple of options, which you can provide to this plugin too:

// Example for passing options to the plugin.

eleventyConfig.addPlugin(
  typesetPlugin({
    only: '.article-text', // Run only on HTML content within a certain CSS selector
    disable: ['smallCaps'], // Disable typesetting feature 'smallCaps'
    // etc.
  })
);

You can use the options to let this plugin run only on some certain parts of your content. This is actually a quite nice optimisation, since I discovered running Typeset on my full site (pages and posts) takes a few seconds. So unless you wanna typeset all HTML on your site, be sure to scope the plugin with the only option to a selector that wraps your article content.

License

MIT.

You can’t perform that action at this time.