@leafac/rehype-shiki
    TypeScript icon, indicating that this package has built-in type declarations

    1.3.1 • Public • Published

    @leafac/rehype-shiki

    Rehype plugin to highlight code blocks with Shiki

    Source Package Continuous Integration

    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();
    ```

    Example

    $ npm install typescript ts-node unified remark-parse remark-rehype @leafac/rehype-shiki shiki rehype-stringify

    tsconfig.json

    {
      "compilerOptions": {
        "target": "ES2019",
        "module": "commonjs",
        "strict": true,
        "esModuleInterop": true
      }
    }

    example.ts

    import unified from "unified";
    import remarkParse from "remark-parse";
    import remarkRehype from "remark-rehype";
    import rehypeShiki from "@leafac/rehype-shiki";
    import * as shiki from "shiki";
    import rehypeStringify from "rehype-stringify";
    
    (async () => {
      console.log(
        unified()
          .use(remarkParse)
          .use(remarkRehype)
          .use(rehypeShiki, {
            highlighter: await shiki.getHighlighter({ theme: "light-plus" }),
          })
          .use(rehypeStringify)
          .processSync(
            `
    \`\`\`javascript
    return unified();
    \`\`\`
    `
          )
          .toString()
      );
    
      console.log();
    
      console.log(
        unified()
          .use(remarkParse)
          .use(remarkRehype)
          .use(rehypeShiki, {
            highlighter: {
              light: await shiki.getHighlighter({ theme: "light-plus" }),
              dark: await shiki.getHighlighter({ theme: "dark-plus" }),
            },
          })
          .use(rehypeStringify)
          .processSync(
            `
    \`\`\`javascript
    return unified();
    \`\`\`
    `
          )
          .toString()
      );
    })();
    $ npx ts-node example.ts
    <pre class="shiki" style="background-color: #FFFFFF"><code><span class="line"><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #795E26">unified</span><span style="color: #000000">();</span></span></code></pre>
    
    
                <div class="rehype-shiki">
    
                        <div class="light">
                          <pre class="shiki" style="background-color: #FFFFFF"><code><span class="line"><span style="color: #AF00DB">return</span><span style="color: #000000"> </span><span style="color: #795E26">unified</span><span style="color: #000000">();</span></span></code></pre>
                        </div>
    
                        <div class="dark">
                          <pre class="shiki" style="background-color: #1E1E1E"><code><span class="line"><span style="color: #C586C0">return</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">unified</span><span style="color: #D4D4D4">();</span></span></code></pre>
                        </div>
    
                </div>

    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…

    Install

    npm i @leafac/rehype-shiki

    DownloadsWeekly Downloads

    63

    Version

    1.3.1

    License

    MIT

    Unpacked Size

    31.6 kB

    Total Files

    16

    Last publish

    Collaborators

    • leafac