vuepress-plugin-shiki-twoslash
TypeScript icon, indicating that this package has built-in type declarations

1.0.39 • Public • Published

VuePress 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 vuepress-plugin-shiki-twoslash

  2. Include "vuepress-plugin-shiki-twoslash" in the plugins section of ./vuepress/config.ts

    + import vuepressShikiTwoslash from "vuepress-plugin-shiki-twoslash"
    
    export default defineUserConfig<DefaultThemeOptions>({
      lang: 'en-US',
      title: 'Hello VuePress',
      description: 'Just playing around',
    
      themeConfig: {
        logo: 'https://vuejs.org/images/logo.png',
      },
    + plugins: [
    +   [vuepressShikiTwoslash, { theme: "nord" }]
    + ]
    })
  3. Go read npmjs.com/package/remark-shiki-twoslash to see what is available, this module leaves all the heavy work to that module.

Readme

Keywords

none

Package Sidebar

Install

npm i vuepress-plugin-shiki-twoslash

Weekly Downloads

9

Version

1.0.39

License

MIT

Unpacked Size

5.96 kB

Total Files

5

Last publish

Collaborators

  • orta
  • typescript-deploys
  • shiki-deploys