Benjamin Canac
MeProjects

//tiptap-extension-code-block-shikibybenjamincanac

tiptap-extension-code-block-shiki

🎨 Use Shiki syntax highlighting for codeblocks in TipTap

0
0
0
View on GitHub

Shiki Tiptap Extension

Use Shiki syntax highlighting for codeblocks in Tiptap.

Installation

npm install shiki tiptap-extension-code-block-shiki

Usage

The extension extends CodeBlock.

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import CodeBlockShiki from 'tiptap-extension-code-block-shiki'

new Editor({
  extensions: [
    StarterKit.configure({ codeBlock: false }),
    CodeBlockShiki.configure({
      defaultTheme: 'tokyo-night',
    }),
  ],
})

Go into your TipTap editor, write ```ts, press Enter, and write some code! It loads the language on the fly.

Dark Mode Support

You can optionally supply themes to use for light and dark modes

import { Editor } from '@tiptap/core'
import StarterKit from '@tiptap/starter-kit'
import CodeBlockShiki from 'tiptap-extension-code-block-shiki'

new Editor({
  extensions: [
    StarterKit.configure({ codeBlock: false }),
    CodeBlockShiki.configure({
      defaultTheme: 'tokyo-night', // Fallback theme
      themes: {
        light: 'github-light',
        dark: 'github-dark',
      },
    }),
  ],
})

Note: In order to enable theme switching, you must add this snippet to your CSS

@media (prefers-color-scheme: dark) {
  .tiptap .shiki,
  .tiptap .shiki span {
    color: var(--shiki-dark) !important;
    background-color: var(--shiki-dark-bg) !important;
  }
}

/* 
    If you prefer to manually toggle using data-theme attribute:
*/
[data-theme='dark'] .tiptap .shiki,
[data-theme='dark'] .tiptap .shiki span {
  color: var(--shiki-dark) !important;
  background-color: var(--shiki-dark-bg) !important;
}

/*  
    If you prefer to manually toggle using Class-based Dark Mode:
*/
html.dark .tiptap .shiki,
html.dark .tiptap .shiki span {
  color: var(--shiki-dark) !important;
  background-color: var(--shiki-dark-bg) !important;
}

Custom Theme Support

You can optionally supply your own custom themes

import type { ThemeRegistration } from 'shiki'

const myTheme: ThemeRegistration = {
  name: 'my-theme',
  type: 'dark',
  colors: { 'editor.background': '#1e1e2e' },
  tokenColors: [/* ... */]
}

CodeBlockShiki.configure({
  defaultTheme: 'my-theme',
  customThemes: [myTheme],
})

Demo

I posted a small screen recording here: https://mastodon.social/@timomeh/112282962825285237

Settings

The extension extends CodeBlock and forwards its settings. It additionally adds the following settings:

defaultTheme

Which theme to use by default. See https://shiki.style/themes.

themes

Optionally specify themes for light and dark mode. See https://shiki.matsu.io/guide/dual-themes

defaultLanguage

Which language to use, when no language was provided. See https://shiki.style/languages.

customThemes

Register custom themes. See https://shiki.style/guide/load-theme#load-custom-themes.

Notes

Lazy loading

The library loads themes and languages asynchronously. You may notice that the code is not highlighted for a short moment while the theme and language are loading.

Unknown language fallback

If you use a language that Shiki doesn’t support, it will silently switch to no syntax highlighting.

Contributing

Credits

Most of this library is just a combination of code from two other libraries:

License

MIT

[beta]v0.14.0