v1.0.0

Shiki v1.0 is a major rewrite that solves most of the long-lasting issues. Previously known as Shikiji, now it's merged back to Shiki.

👉 Migration Guide

Notable Highlights

• Full ESM support, no static assets or CDN settings are needed anymore
• No filesystem dependencies, platform agnostic, works for Node.js, browsers, and any other modern runtime out-of-box.
• Dual themes built-in, to support Light/Dark modes efficiently
• Transformers & Decorations API, maximize the customizability
• Official rehype and markdown-it plugin
• TwoSlash integration is now a Shiki transformer instead of a wrapper
• More themes and better language support. Maintained as a standalone repo: https://github.com/shikijs/textmate-grammars-themes
• New docs: https://shiki.style

Generated Changelog

   🚨 Breaking Changes

• Flat lang registration  -  by @antfu (d7f66)
• Shorten languages/ to langs/  -  by @antfu (2f4fe)
• Change codeToThemedTokens options  -  by @antfu (5d8cf)
• Rename codeToHtmlDualThemes to codeToHtmlThemes  -  by @antfu (57daa)
• Use hast, unify codeToHtmlThemes to codeToHtml  -  by @antfu in #9 (26cd5)
• Rework hastTransform to transforms  -  by @antfu (3d245)
• Improve return type of codeToTokensWithThemes, close #37  -  by @antfu in #37 (3acf1)
• Add unwasm condition in exports  -  by @antfu in #72 (96300)
• Remove deprecated APIs  -  by @antfu in #75 (97c96)
• Consistent case of Twoslash  -  by @antfu (f740b)
• Rename to shiki  -  by @antfu (a04b3)
• Remove renderers  -  by @antfu (718b0)
• Merge Shikiji back into Shiki for v1.0  -  by @antfu (c72a5)
• Remove all deprecated APIs  -  by @antfu (1a39f)
• Refactor internal context  -  by @antfu (5ba2a)
• core:
  • Rename transformer hook token to span to avoid confusion  -  by @antfu (eb3b8)
• markdown-it:
  • Deprecate and disable highlightLines option  -  by @antfu (21e99)
• rehype:
  • Deprecate and disable highlightLines option  -  by @antfu (fe0e4)
• twoslash:
  • Improve rich renderer  -  by @antfu in #41 (0bd42)
  • Move to twoslash package for better performance and composablity  -  by @antfu in #91 (fc67e)
  • Rename renderer hook nodeCompletions to nodeCompletion  -  by @antfu (b7637)
  • Support highlight  -  by @antfu (1ebe8)
  • Fix highlight typos  -  by @jxom in #102 (b8c4c)

   🚀 Features

• Rewrite from shiki  -  by @antfu (c14ed)
• Types for each export  -  by @antfu (1ffb6)
• Improve types  -  by @antfu (762d5)
• Auto module default resolution  -  by @antfu (de847)
• Improve module resolution  -  by @antfu (fa20a)
• Bundle include embedded languages  -  by @antfu (7e85d)
• Provide singleton shorthands  -  by @antfu (e00df)
• Add codeToHtmlDualThemes  -  by @antfu in #5 (751f9)
• Support multiple themes for renderToHtmlDualThemes  -  by @antfu (cedad)
• Support no default color for dual themes, #6  -  by @antfu in #6 (69b99)
• Add codeToTokensWithThemes, fix #7  -  by @antfu and starknt in #7 (b3cb0)
• Port back ansi support  -  by @antfu (80c74)
• Add rehype and markdown-it plugins  -  by @antfu in #12 (f096f)
• Wip shikiji-compact package  -  by @antfu (ea2d6)
• Support passing raw theme object on generation  -  by @antfu (03db7)
• Improve compatibility  -  by @antfu (8e11f)
• Improve compat  -  by @antfu (3b41d)
• Support font-style for multiples themes  -  by @antfu (b6a42)
• Support lang on the meta  -  by @ovflowd in #26 (f0e6b)
• Treat plain as plain text, close #24  -  by @antfu in #24 (6ae61)
• Support multiple transformers  -  by @antfu (50466)
• Introduce transformers package  -  by @antfu in #32 (370a4)
• Add preprocess and postprocess hooks to transformer  -  by @antfu (c1aba)
• Support lang alias  -  by @antfu (fe120)
• Introduce twoslash transformer  -  by @antfu in #39 (06742)
• Expose more utils  -  by @antfu (53343)
• Additional codeToHast util in transformer context  -  by @antfu (fc857)
• Adjust css  -  by @antfu (724ad)
• New shikiji-core package, improve bundling  -  by @antfu in #42 (60184)
• Introduce shikiji-monaco package  -  by @antfu (61794)
• Provide more info for languages and themes  -  by @antfu (d187e)
• Support grammar injection  -  by @antfu in #48 (c176b)
• Change source from shiki to tm-grammars and tm-themes  -  by @antfu (be0c9)
• Introduce web bundle  -  by @antfu in #56 (9cc01)
• Introduce lazy embedded, more efficient bundle  -  by @antfu...

v1.0.0-rc.0

   🚨 Breaking Changes

• Remove all deprecated APIs  -  by @antfu (1a39f)
• Refactor internal context  -  by @antfu (5ba2a)

   🚀 Features

• twoslash:
  • Support extend popupError  -  by @antfu (df62d)
  • Wrap tokens in a single span for errors  -  by @antfu (efea5)

   🐞 Bug Fixes

• twoslash:
  • Improve types  -  by @antfu (5a177)
• vitepress:
  • Fix types  -  by @antfu (61b87)
  • Support custom explicitTrigger  -  by @antfu (bd38e)

    View changes on GitHub

v1.0.0-beta.6

   🚀 Features

• twoslash:
  • Allow provide custom trigger  -  by @antfu (6b177)
  • Allow lossy custom twoslash implementation  -  by @antfu (38a9f)
  • Support errorRendering to render error in hover style  -  by @antfu (28e32)
• vitepress:
  • Support errorRendering hover  -  by @antfu (2c528)

   🐞 Bug Fixes

• Stricter types  -  by @antfu (1b3dc)
• SplitLines extra new lines, fix #576  -  by @antfu in #576 (0bb28)

    View changes on GitHub

v1.0.0-beta.5

   🐞 Bug Fixes

• Update grammar registry, fix html in markdown highlighting  -  by @antfu (502ed)

    View changes on GitHub

v1.0.0-beta.4

   🚀 Features

• Apply full line decoration when possible  -  by @antfu (52f6a)

   🐞 Bug Fixes

• Improve error handling  -  by @antfu (d9fcd)
• vitepress: Css style  -  by @antfu (d8c07)

    View changes on GitHub

v1.0.0-beta.3

   🚀 Features

• Introduce Decorations API  -  by @antfu in #574 (e0fcf)

   🐞 Bug Fixes

• MergeWhitespaceTokens offset calculation  -  by @antfu (3cf46)

    View changes on GitHub

v1.0.0-beta.2

   🚀 Features

• Add codeToTokens API, rename codeToThemedTokens to codeToTokensBase  -  by @antfu in #572 (d123b)
• Add addClassToHast to transformer context  -  by @antfu in #573 (6dfcd)

    View changes on GitHub

v1.0.0-beta.1

   🚀 Features

• Support ansi background color, fix #432  -  by @antfu in #432 (19455)
• Add fortran support  -  by @antfu (55706)
• Export tokensToHast  -  by @antfu (e959e)
• Support passing includeExplanation, close #568  -  by @antfu in #568 (cebf1)
• transformers: Support word highlighting across multiple tokens  -  by @fuma-nama and @antfu in #561 (70fdc)

   🐞 Bug Fixes

• Improve css variable handling for background  -  by @antfu (2964d)
• core: Sub export types, fix #566  -  by @antfu in #566 (72824)

    View changes on GitHub

v1.0.0-beta.0

In v1.0, we migrated Shikiji back to Shiki, which brings a lot of improvements and fixes, for more details, check:

• #557
• Migration Guide

v0.14.6

0.14.6 | 2023-12-07

🚀 Features & Fixes

• fix: update razor grammar source
• fix: update kotlin language source
• fix: update vue syntax path

🙌 Contributions

• feat: add csv highlighting | #536 | @mashehu