gatsby-remark-shiki-twoslash

3.0.38 • Public • Published

gatsby-remark-shiki-twoslash

Sets up markdown code blocks to run through shiki which means it gets the VS Code quality syntax highlighting. This part is basically the same as gatsby-remark-shiki.

Plugin Setup

Setup

  1. Install the dependency: yarn add gatsby-remark-shiki-twoslash

  2. Include "gatsby-remark-shiki-twoslash" in the plugins section of gatsby-transformer-remark

    {
      resolve: `gatsby-transformer-remark`,
      options: {
        plugins: [
          "gatsby-remark-autolink-headers",
    +       {
    +         resolve: "gatsby-remark-shiki-twoslash",
    +         options: {
    +            theme: "nord",
    +         }
    +       },
          "gatsby-remark-copy-linked-files",
          "gatsby-remark-smartypants",
        ],
      },
    }

    If you have gatsby-remark-prismjs in, delete it from the config and run yarn remove gatsby-remark-prismjs.

  3. Go read npmjs.com/package/remark-shiki-twoslash to see what is available, this module leaves all the heavy work to that module.

Keywords

none

Install

DownloadsWeekly Downloads

62

Version

3.0.38

License

MIT

Unpacked Size

6.28 kB

Total Files

5

Last publish

Collaborators

  • orta
  • typescript-deploys
  • shiki-deploys