Socket
Socket
Sign inDemoInstall

vuepress-plugin-shiki-twoslash

Package Overview
Dependencies
Maintainers
3
Versions
40
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

vuepress-plugin-shiki-twoslash

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


Version published
Maintainers
3
Created
Source

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.

FAQs

Package last updated on 28 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc