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

package/LICENSE.md

@@ -6,4 +6,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -21,13 +21,66 @@ new Editor({
   extensions: [
     StarterKit.configure({ codeBlock: false }),
     CodeBlockShiki.configure({
-      defaultTheme: 'tokyo-night'
+      defaultTheme: 'tokyo-night',
     }),
   ],
 })
 ```
 
-Go into your TipTap editor, write `` ```ts ``, press <kbd>Enter</kbd>, and write some code! It loads the language on the fly.
+Go into your TipTap editor, write ` ```ts `, press <kbd>Enter</kbd>, 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
+
+```ts
+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
+
+```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;
+}
+```
 
 ## Demo
 
@@ -41,6 +94,10 @@ The extension extends [CodeBlock](https://tiptap.dev/docs/editor/api/nodes/code-
 
 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.
@@ -66,4 +123,4 @@ Most of this library is just a combination of code from two other libraries:
 
 ## License
 
-MIT
+MIT

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

@@ -10,6 +10,10 @@ export default CodeBlockShiki;
 export declare interface CodeBlockShikiOptions extends CodeBlockOptions {
     defaultLanguage: BundledLanguage | null | undefined;
     defaultTheme: BundledTheme;
+    themes: {
+        light: BundledTheme;
+        dark: BundledTheme;
+    } | null | undefined;
 }
 
 export { }