tiptap-extension-code-block-shiki 0.7.0 → 1.1.0

package/README.md

@@ -42,7 +42,7 @@ new Editor({
   extensions: [
     StarterKit.configure({ codeBlock: false }),
     CodeBlockShiki.configure({
-      defaultTheme: 'tokyo-night' // Fallback theme
+      defaultTheme: 'tokyo-night', // Fallback theme
       themes: {
         light: 'github-light',
         dark: 'github-dark',
@@ -82,6 +82,26 @@ html.dark .tiptap .shiki span {
 }
 ```
 
+### Custom Theme Support
+
+You can optionally supply your own custom themes
+
+```ts
+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
@@ -94,7 +114,7 @@ The extension extends [CodeBlock](https://tiptap.dev/docs/editor/api/nodes/code-
 
 Which theme to use by default. See https://shiki.style/themes.
 
-## `themes`
+### `themes`
 
 Optionally specify themes for light and dark mode. See https://shiki.matsu.io/guide/dual-themes
 
@@ -102,6 +122,10 @@ Optionally specify themes for light and dark mode. See https://shiki.matsu.io/gu
 
 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

package/dist/tiptap-extension-code-block-shiki.d.ts

@@ -2,6 +2,7 @@ import { BundledLanguage } from 'shiki';
 import { BundledTheme } from 'shiki';
 import { CodeBlockOptions } from '@tiptap/extension-code-block';
 import { Node as Node_2 } from '@tiptap/core';
+import { ThemeRegistration } from 'shiki';
 
 declare const CodeBlockShiki: Node_2<CodeBlockShikiOptions, any>;
 export { CodeBlockShiki }
@@ -9,11 +10,12 @@ export default CodeBlockShiki;
 
 export declare interface CodeBlockShikiOptions extends CodeBlockOptions {
     defaultLanguage: BundledLanguage | null | undefined;
-    defaultTheme: BundledTheme;
+    defaultTheme: BundledTheme | (string & {});
     themes: {
         light: BundledTheme;
         dark: BundledTheme;
     } | null | undefined;
+    customThemes: ThemeRegistration[] | null | undefined;
 }
 
 export { }