An ESM-focused rewrite of shiki, a beautiful syntax highlighter based on TextMate grammars.
- All grammars/themes/wasm served as pure-ESM, no more CDN, no more assets.
- Portable. Does not rely on Node.js APIs or the filesystem, works in any modern JavaScript runtime.
- Drop CJS and IIFE build, focus on ESM (or you can use bundlers).
- Bundles languages/themes composedly.
- Light/Dark dual themes support.
- Zero-dependencies.
- Simplified APIs.
- Please don't hate me Pine 😜 (What's Next?)
npm install -D shikiji
Basic usage is pretty much the same as shiki
, only that some APIs are dropped, (for example, the singular theme
options). Each theme and language file are dynamically imported ES modules, it would be better to list the languages and themes explicitly to have the best performance.
import { getHighlighter } from 'shikiji'
const shiki = await getHighlighter({
themes: ['nord'],
langs: ['javascript'],
})
// optionally, load themes and languages after creation
await shiki.loadTheme('vitesse-light')
await shiki.loadLanguage('css')
const code = shiki.codeToHtml('const a = 1', { lang: 'javascript' })
Unlike shiki
, shikiji
does not load any themes or languages when not specified.
import { getHighlighter } from 'shikiji'
const shiki = await getHighlighter()
shiki.codeToHtml('const a = 1', { lang: 'javascript' }) // throws error, `javascript` is not loaded
await shiki.loadLanguage('javascript') // load the language
If you want to load all themes and languages (not recommended), you can iterate all keys from bundledLanguages
and bundledThemes
.
import { bundledLanguages, bundledThemes, getHighlighter } from 'shikiji'
const shiki = await getHighlighter({
themes: Object.keys(bundledThemes),
langs: Object.keys(bundledLanguages),
})
shiki.codeToHtml('const a = 1', { lang: 'javascript' })
Or if your usage can be async, you can try the shorthands which will load the theme/language on demand.
When importing shikiji
, all the themes and languages are bundled as async chunks. Normally it won't be a concern to you as they are not being loaded if you don't use them. While in some cases you want to control what to bundle size, you can use the core and compose your own bundle.
// `shikiji/core` entry does not include any themes or languages or the wasm binary.
import { getHighlighterCore } from 'shikiji/core'
// `shikiji/wasm` contains the wasm binary inlined as base64 string.
import { getWasmInlined } from 'shikiji/wasm'
// directly import the theme and language modules, only the ones you imported will be bundled.
import nord from 'shikiji/themes/nord.mjs'
const shiki = await getHighlighterCore({
themes: [
// instead of strings, you need to pass the imported module
nord,
// or a dynamic import if you want to do chunk splitting
import('shikiji/themes/vitesse-light.mjs')
],
langs: [
import('shikiji/langs/javascript.mjs'),
// shikiji will try to interop the module with the default export
() => import('shikiji/langs/css.mjs'),
// or a getter that returns custom grammar
async () => JSON.parse(await fs.readFile('my-grammar.json', 'utf-8'))
],
loadWasm: getWasmInlined
})
// optionally, load themes and languages after creation
await shiki.loadTheme(import('shikiji/themes/vitesse-light.mjs'))
const code = shiki.codeToHtml('const a = 1', { lang: 'javascript' })
shikiji
is published as ESM-only to reduce the package size. It's still possible to use it in CJS, as Node.js supports importing ESM modules dynamically in CJS.
For example, the following ESM code:
// ESM
import { getHighlighter } from 'shikiji'
async function main() {
const shiki = await getHighlighter({
themes: ['nord'],
langs: ['javascript'],
})
const code = shiki.codeToHtml('const a = 1', { lang: 'javascript' })
}
Can be written in CJS as:
// CJS
async function main() {
const { getHighlighter } = await import('shikiji')
const shiki = await getHighlighter({
themes: ['nord'],
langs: ['javascript'],
})
const code = shiki.codeToHtml('const a = 1', { lang: 'javascript' })
}
To use shikiji
in the browser via CDN, you can use esm.run from jsDelivr.
<body>
<div id="foo"></div>
<script type="module">
import { codeToHtml } from 'https://esm.run/[email protected]' // be sure to specify the exact version
const foo = document.getElementById('foo')
foo.innerHTML = await codeToHtml('console.log("Hi")', { lang: 'js', theme: 'vitesse-light' })
</script>
</body>
Cloudflare Workers does not support initializing WebAssembly from binary data, so the default wasm build won't work. You need to upload the wasm as assets and import it directly.
Meanwhile, it's also recommended to use the Fine-grained Bundle approach to reduce the bundle size.
import { getHighlighterCore, loadWasm } from 'shikiji/core'
import nord from 'shikiji/themes/nord.mjs'
import js from 'shikiji/langs/javascript.mjs'
// import wasm as assets
import wasm from 'shikiji/onig.wasm'
// load wasm outside of `fetch` so it can be reused
await loadWasm(obj => WebAssembly.instantiate(wasm, obj))
export default {
async fetch() {
const highlighter = await getHighlighterCore({
themes: [nord],
langs: [js],
})
return new Response(highlighter.codeToHtml('console.log(\'shiki\');', { lang: 'js' }))
},
}
In addition to the getHighlighter
function, shikiji
also provides some shorthand functions for simpler usage.
import { codeToHtml, codeToThemedTokens } from 'shikiji'
const code = await codeToHtml('const a = 1', { lang: 'javascript', theme: 'nord' })
const tokens = await codeToThemedTokens('<div class="foo">bar</div>', { lang: 'html', theme: 'min-dark' })
Currently supports:
codeToThemedTokens
codeToHtml
codeToHtmlDualThemes
codeToThemedTokensDualThemes
Internally they maintain a singleton highlighter instance and load the theme/language on demand. Different from shiki.codeToHtml
, the codeToHtml
shorthand function returns a Promise and lang
and theme
options are required.
Note: These are only available in the bundled usage, a.k.a the main
shikiji
entry. If you are using the fine-grained bundle, you can create your own shorthands by porting this file.
shikiji
added an experimental light/dark dual themes support. Different from markdown-it-shiki's approach which renders the code twice, shikiji
's dual themes approach uses CSS variables to store the colors on each token. It's more performant with a smaller bundle size.
Use codeToHtmlDualThemes
to render the code with dual themes:
import { getHighlighter } from 'shikiji'
const shiki = await getHighlighter({
themes: ['nord', 'min-light'],
langs: ['javascript'],
})
const code = shiki.codeToHtmlDualThemes('console.log("hello")', {
lang: 'javascript',
themes: {
light: 'vitesse-light',
dark: 'nord',
}
})
The following HTML will be generated (demo preview):
<pre
class="shiki shiki-dual-themes min-light--nord"
style="background-color: #ffffff;--shiki-dark-bg:#2e3440ff;color: #ffffff;--shiki-dark-bg:#2e3440ff"
tabindex="0"
>
<code>
<span class="line">
<span style="color:#1976D2;--shiki-dark:#D8DEE9">console</span>
<span style="color:#6F42C1;--shiki-dark:#ECEFF4">.</span>
<span style="color:#6F42C1;--shiki-dark:#88C0D0">log</span>
<span style="color:#24292EFF;--shiki-dark:#D8DEE9FF">(</span>
<span style="color:#22863A;--shiki-dark:#ECEFF4">"</span>
<span style="color:#22863A;--shiki-dark:#A3BE8C">hello</span>
<span style="color:#22863A;--shiki-dark:#ECEFF4">"</span>
<span style="color:#24292EFF;--shiki-dark:#D8DEE9FF">)</span>
</span>
</code>
</pre>
To make it reactive to your site's theme, you need to add a short CSS snippet:
@media (prefers-color-scheme: dark) {
.shiki {
background-color: var(--shiki-dark-bg) !important;
color: var(--shiki-dark) !important;
}
.shiki span {
color: var(--shiki-dark) !important;
}
}
html.dark .shiki {
background-color: var(--shiki-dark-bg) !important;
color: var(--shiki-dark) !important;
}
html.dark .shiki span {
color: var(--shiki-dark) !important;
}
It's also possible to support more than two themes. In the themes
object, you can have an arbitrary number of themes, and specify the default theme with defaultColor
option.
const code = shiki.codeToHtmlDualThemes('console.log("hello")', {
lang: 'javascript',
themes: {
light: 'github-light',
dark: 'github-dark',
dim: 'github-dimmed',
// any number of themes
},
// optional customizations
defaultColor: 'light',
cssVariablePrefix: '--shiki-'
})
Token would be generated like:
<span style="color:#1976D2;--shiki-dark:#D8DEE9;--shiki-dim:#566575">console</span>
And then update your CSS snippet to control then each theme taking effect. Here is an example:
You can inspect the bundle size in detail on pkg-size.dev/shikiji.
As of v0.2.2
, measured at 12th, August 2023:
Bundle | Size (minified) | Size (gzip) | Notes |
---|---|---|---|
shikiji |
5.9 MB | 1.2 MB | includes all themes and languages as async chunks |
shikiji/core |
75 KB | 23 KB | no themes or languages, compose on your own |
shikiji/wasm |
623 KB | 231 KB | wasm binary inlined as base64 string |
Shikiji is a usable exploration of improving the experience of using shiki
in various of scenarios. It's intended to push some of the ideas back to shiki
, and eventually, this package might not be needed. Before that, you can use it as a replacement for shiki
if you have similar requirements. It would be great to hear your feedback and suggestions in the meantime!