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

@leafac/rehype-shiki

v2.2.1

Published

Rehype plugin to highlight code blocks with Shiki

Downloads

4,577

Readme

Installation

$ npm install @leafac/rehype-shiki shiki

Format

Code blocks must have the following format:

<pre>
<code class="language-javascript">
return unified();
</code>
</pre>

This is the format produced by remark-parse & remark-rehype from the following Markdown:

```javascript
return unified();
```

Usage

See source/index.test.ts for examples.

Options

  • highlighter (required): An instance of the Shiki highlighter, or an object whose keys are identifiers and values are Shiki highlighters, in which case @leafac/rehype-shiki combines the outputs of all the highlighters.
  • throwOnUnsupportedLanguage (default: false): A boolean indicating whether to throw an exception if a code block refers to an unsupported language.

Security

@leafac/rehype-shiki doesn’t open you up to cross-site scripting (XSS) attacks as long as Shiki doesn’t (which it doesn’t).

How Is This Different from rehype-shiki?

rehype-shiki is great! That’s how I learned about Shiki and I fell in love with it. The following are the ways in which @leafac/rehype-shiki is different:

  1. TypeScript support.
  2. Shiki is declared as a peerDependency, so @leafac/rehype-shiki doesn’t have to be updated when new versions of Shiki are released (as long as Shiki’s API remain compatible). See https://github.com/rsclarke/rehype-shiki/pull/48 https://github.com/rsclarke/rehype-shiki/pull/46 https://github.com/rsclarke/rehype-shiki/issues/47 https://github.com/rsclarke/rehype-shiki/issues/2.
  3. You must pass in an instance of the Shiki highlighter, @leafac/rehype-shiki won’t create one for you. This means that:
    1. The Shiki highlighter instance is reused on every invocation of the processor, instead of being recreated every time you call the processor.
    2. The transformer is synchronous, so you may use it with .processSync().
  4. Instead of looking at the tokens produced by Shiki and generating hast, @leafac/rehype-shiki lets Shiki produce HTML and parses the result. The advantage is that when Shiki improves the output with things like italics @leafac/rehype-shiki will pick the changes up with no extra work. The disadvantage is that we’re producing HTML as a string and then parsing it right back; this is slower, but in most cases it won’t matter and I think the previous advantages outweighs this disadvantage. (Also, the language-* class will be removed from the produced HTML, so you may need to adapt your CSS.)
  5. Support for multiple highlighters.

That said, I contacted the maintainers of rehype-shiki and try to merge the code bases. We’ll see…

Changelog

2.2.0

2.1.0

  • Added a feature that preserves the position of the top element node. Useful for products that need to map the HTML back to the Markdown that generated it (see tests).

2.0.0