Skip to content

Commit ac10b3a

Browse files
committedSep 5, 2024··
feat: make createCssVariablesTheme no longer experimental
1 parent a26ab57 commit ac10b3a

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed
 

‎docs/guide/regex-engines.md

+4
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ const shiki = await createShiki({
3838

3939
## JavaScript RegExp Engine (Experimental)
4040

41+
::: warning Experimental
42+
This feature is experimental and may change without following semver.
43+
:::
44+
4145
This experimental engine uses JavaScript's native RegExp. As TextMate grammars' regular expressions are in Oniguruma flavor that might contains syntaxes that are not supported by JavaScript's RegExp, we use [`oniguruma-to-js`](https://github.com/antfu/oniguruma-to-js) to lowering the syntaxes and try to make them compatible with JavaScript's RegExp.
4246

4347
```ts {3,8}

‎docs/guide/theme-colors.md

-4
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,6 @@ This is only allowed for the `colorReplacements` option and not for the theme ob
9090

9191
## CSS Variables Theme
9292

93-
::: warning Experimental
94-
This feature is experimental and may change without following semver.
95-
:::
96-
9793
Shiki provides a factory function helper `createCssVariablesTheme` for creating a theme that uses CSS variables easier. Note that this theme is a lot less granular than most of the other themes and requires to define the CSS variables in your app. This is provided for easier migration from Shiki's [`css-variables theme`](https://github.com/shikijs/shiki/blob/main/docs/themes.md#theming-with-css-variables). For better highlighting result, we recommend construct the theme manually with [Arbitrary Color Values](#arbitrary-color-values) or use [Color Replacements](#color-replacements) to override an existing theme.
9894

9995
This theme is **not included by default** and must be registered explicitly:

‎packages/shiki/src/theme-css-variables.ts

-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@ export interface CssVariablesThemeOptions {
3333
/**
3434
* A factory function to create a css-variable-based theme
3535
*
36-
* @experimental This API is experimental and may change without following semver
3736
* @see https://shiki.style/guide/theme-colors#css-variables-theme
3837
*/
3938
export function createCssVariablesTheme(options: CssVariablesThemeOptions = {}): ThemeRegistration {

0 commit comments

Comments
 (0)
Please sign in to comment.