npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

eleventy-plugin-torchlight

v0.3.0

Published

This plugin runs your HTML files through Torchlight.dev for syntax highlighting

Downloads

21

Readme

eleventy-plugin-torchlight

This is a plugin for the static site generator Eleventy to syntax highlight your code blocks with torchlight.dev.

Prerequisites

To use this plugin you need to be registered on torchlight.dev and have obtained an API key.

Installation

npm install eleventy-plugin-torchlight #or
yarn add eleventy-plugin-torchlight

Then, include it in your .eleventy.js config file:

const torchlight = require('eleventy-plugin-torchlight');

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

Configuration

Run npx torchlight init to initialize a default torchlight config. If you don't create a config yourself this plugin assumes this defaults to match 11ty's defaults:

{
    token: process.env.TORCHLIGHT_TOKEN,
    highlight: {
        input: '_site'
    }
}

If you create a new config remember to update the config to match the input path of Eleventy!

To verify everything works you can run Eleventy like this to pass the token as environment variable:

TORCHLIGHT_TOKEN=your_token npm run start

Your code should now be highlighted.

If you are for example using Netflify you can add the token via your site's settings so it's available during the build.

Cache

Torchlight uses a cache to prevent highlighting code blocks that don't have changed.
By default it uses a file based cache which created a directory called cache.

Make sure you add this folder to your .eleventyignore file so it doesn't trigger rebuilds after highlighting your output files.

Credits

Thanks to @5t3ph for her eleventy-plugin-template and Aaron Francis for Torchlight.