hexo-shiki-twoslash

A Hexo plugin which adds shiki with optional twoslash-powered code samples

Usage no npm install needed!

<script type="module">
  import hexoShikiTwoslash from 'https://cdn.skypack.dev/hexo-shiki-twoslash';
</script>

README

Hexo Shiki Twoslash

Sets up markdown code blocks to run through shiki which means it gets the VS Code quality syntax highlighting mixed with the twoslash JavaScript tooling from the TypeScript website.

Setup

  1. Install the dependency: yarn add hexo-shiki-twoslash

  2. Disable highlight in ./config.yml:

    highlight:
    -  enable: true
    +  enable: false
    
  3. Configure the plugin via ./config.yml:

    shiki_twoslash:
      theme: "nord"
    
  4. Follow the steps in npmjs.com/package/remark-shiki-twoslash to add the CSS requirements.

  5. Learn in npmjs.com/package/remark-shiki-twoslash to see what is available, this package leaves all the heavy work to that module.