@olets/eleventy-plugin-shiki-twoslash

This is a fork of shikijs/twoslash's eleventy-plugin-shiki-twoslash package made available as a standalone repo.

Learn more in this repo's CONTRIBUTING.md, and in shikijs/twoslash's eleventy-plugin-shiki-twoslash package's README.md.

Syntax highlight Eleventy Markdown code blocks with @olets/shiki, a fork of Shiki v0.x.

This is an alternative to @shikijs/markdown-it. It behaves like shikijs/twoslash's eleventy-plugin-shiki-twoslash package, providing an easier migration pathway for Eleventy users who used that in Eleventy < 3.

[!IMPORTANT] These are the significant differences between @olets/eleventy-plugin-shiki-twoslash and ShikiJS's eleventy-plugin-shiki-twoslash and remark-shiki-twoslash. As of this writing:

1. @olets/eleventy-plugin-shiki-twoslash supports Eleventy v3.x, and does not support Eleventy < 3. (ShikiJS's eleventy-plugin-shiki-twoslash only supports Eleventy < 3.)
2. @olets/eleventy-plugin-shiki-twoslash endeavors to support all the themes and languages supported by Shiki 1.x. (ShikiJS's eleventy-plugin-shiki-twoslash and remark-shiki-twoslash do not receive regular theme and language updates.)

Installation

Replace <package manager> with your package manager. Works with at least bun, npm, pnpm, and yarn.

<package manager> add @olets/eleventy-plugin-shiki-twoslash

Usage

// eleventy.config.js

import shikiTwoslash from "@olets/eleventy-plugin-shiki-twoslash";

export default function (eleventyConfig) {
  eleventyConfig.addPlugin(shikiTwoslash, options)
}

Options

The basic options are theme: <theme name>:

{
  theme: "github-light-high-contrast",
}

and themes: [<light theme name>, <dark theme name>]:

{
  themes: ["github-light-high-contrast", "github-dark-high-contrast"],
}

See @olets/shiki-twoslash's UserConfigSettings type for all options.

Contributing

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Check the Issues to see if your topic has been discussed before or if it is being worked on. You may also want to check the roadmap (see above).

Please read CONTRIBUTING.md before opening a pull request.

License

@olets/eleventy-plugin-shiki-twoslash by Henry Bley-Vroman is released under the MIT license.

Acknowledgments

Forked from https://github.com/shikijs/twoslash/tree/main/packages/eleventy-plugin-shiki-twoslash.