Git Product home page Git Product logo

eleventy-plugin-typeset's Introduction

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.

eleventy-plugin-typeset's People

Contributors

johanbrook avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

eleventy-plugin-typeset's Issues

Error: Cannot find module './typeset'

When I run
npx @11ty/eleventy
it is giving me the error

Error: Cannot find module './typeset'
`Error` was thrown:
    Error: Cannot find module './typeset'
        at Function.Module._resolveFilename (internal/modules/cjs/loader.js:581:15)
        at Function.Module._load (internal/modules/cjs/loader.js:507:25)
        at Module.require (internal/modules/cjs/loader.js:637:17)
        at require (internal/modules/cjs/helpers.js:22:18)
        at Object.<anonymous> (C:\Users\Francis\alwaysdata\eleventy\node_modules\eleventy-plugin-typeset\index.js:1:84)
        at Module._compile (internal/modules/cjs/loader.js:689:30)
        at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
        at Module.load (internal/modules/cjs/loader.js:599:32)
        at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
        at Function.Module._load (internal/modules/cjs/loader.js:530:3)

I have added the config to my .eleventy.js file.
Everything runs ok when I comment out the typeset related bits in that file.

This is what happened when I installed the plugin:

>npm install --save eleventy-plugin-typeset
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\chokidar\node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})
npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules\fsevents):
npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"win32","arch":"x64"})
+ [email protected]
added 19 packages from 14 contributors and audited 6234 packages in 87.887s
found 3 vulnerabilities (1 low, 2 high)
run `npm audit fix` to fix them, or `npm audit` for details

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.