Introduction

Shikiji 式shiki辞ji is a beautiful and powerful syntax highlighter based on TextMate grammar and themes, the same engine as VS Code's syntax highlighting. Provides a very accurate and fast syntax highlighting for almost any mainstream programming language.

No custom RegEx to maintain, no custom CSS to maintain, no custom HTML to maintain. And as your favorite languages and themes in VS Code evolve - your syntax highlighting will evolve too.

Shikiji is a ESM-rewrite of Shiki with quite many improvements. We aim to merge this project back to Shiki as a milestone update. Breaking changes from Shiki and the compatibility build if you are migrating.

About the name, 式shiki辞ji is a Japanese word meaing "Ceremonial Speech". 式shiki is inherited from shiki means "Style" and 辞ji means "Word".

Oh btw, the code blocks in this document is highlighted by Shikiji, as you'd expect :)

Features

• 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.
• ESM-only (CDN Usage, CJS Usage)
• Bundles languages/themes composedly
• Light/Dark themes support
• AST-based transformers addons
• hast support
• TypeScript TwoSlash
• Shiki-compatible build

Playground

Here is a little playground for you to try out how Shikiji highlights your code. Unlike other code blocks that ran on the build time, this playground is rendered on the client side in the browser. Themes and languages are loaded on demand.

TypeScript

────────── Vitesse Dark

Playground

Install Shikiji to use it in your project.

Who is using?

Projects that depend on Shikiji (sort alphabetically):

• Astro
• Lobe UI
• Nuxt Content
• Slidev
• VitePress

Bundle Size

You can inspect the bundle size in detail on pkg-size.dev/shikiji.

As of v0.9.2, measured at 15th, December 2023:

Bundle	Size (minified)	Size (gzip)	Notes
shikiji	6.2 MB	1.2 MB	includes all themes and languages as async chunks
shikiji/core	99 KB	31 KB	without themes or languages, compose on your own
shikiji/wasm	623 KB	231 KB	wasm binary inlined as base64 string