@cyclone-ui/shiki 0.0.15 → 0.0.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/README.md +40 -4
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
# Changelog for Cyclone UI - Shiki
|
|
4
4
|
|
|
5
|
+
## [0.0.17](https://github.com/storm-software/cyclone-ui/releases/tag/shiki%400.0.17) (10/23/2026)
|
|
6
|
+
|
|
7
|
+
### Documentation
|
|
8
|
+
|
|
9
|
+
- **monorepo:** Added `sourcebook` skills and partially generated docs for design system ([0dbff145](https://github.com/storm-software/cyclone-ui/commit/0dbff145))
|
|
10
|
+
|
|
5
11
|
## [0.0.15](https://github.com/storm-software/cyclone-ui/releases/tag/shiki%400.0.15) (10/22/2026)
|
|
6
12
|
|
|
7
13
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -49,7 +49,9 @@ A package containing various [shiki](https://github.com/shikijs/shiki) themes fo
|
|
|
49
49
|
|
|
50
50
|
- [Shiki Themes](#shiki-themes)
|
|
51
51
|
- [Table of Contents](#table-of-contents)
|
|
52
|
+
- [Quick Features](#quick-features)
|
|
52
53
|
- [Installing](#installing)
|
|
54
|
+
- [Usage](#usage)
|
|
53
55
|
- [Reduced Package Size](#reduced-package-size)
|
|
54
56
|
- [Development](#development)
|
|
55
57
|
- [Building](#building)
|
|
@@ -67,6 +69,13 @@ A package containing various [shiki](https://github.com/shikijs/shiki) themes fo
|
|
|
67
69
|
|
|
68
70
|
<!-- END doctoc -->
|
|
69
71
|
|
|
72
|
+
## Quick Features
|
|
73
|
+
|
|
74
|
+
- Six Shiki themes: light, light dimmed, light high contrast, dark, dark
|
|
75
|
+
dimmed, and dark high contrast
|
|
76
|
+
- Theme colors generated from the Cyclone UI design tokens
|
|
77
|
+
- Plain JSON files with no runtime code
|
|
78
|
+
|
|
70
79
|
## Installing
|
|
71
80
|
|
|
72
81
|
Using [pnpm](http://pnpm.io):
|
|
@@ -93,18 +102,45 @@ yarn add -D @cyclone-ui/shiki
|
|
|
93
102
|
|
|
94
103
|
</details>
|
|
95
104
|
|
|
105
|
+
## Usage
|
|
106
|
+
|
|
107
|
+
Register a theme when you create a highlighter, then pass the theme id:
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
import { createHighlighter } from "shiki";
|
|
111
|
+
import theme from "@cyclone-ui/shiki/dark/theme.json" with { type: "json" };
|
|
112
|
+
|
|
113
|
+
const highlighter = await createHighlighter({
|
|
114
|
+
themes: [theme],
|
|
115
|
+
langs: ["javascript"]
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
const html = highlighter.codeToHtml("const x = 1", {
|
|
119
|
+
lang: "javascript",
|
|
120
|
+
theme: "cyclone-dark"
|
|
121
|
+
});
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
The theme ids are `cyclone-light`, `cyclone-light-dimmed`,
|
|
125
|
+
`cyclone-light-high-contrast`, `cyclone-dark`, `cyclone-dark-dimmed`, and
|
|
126
|
+
`cyclone-dark-high-contrast`. See the
|
|
127
|
+
[package documentation](../../docs/packages/shiki.md) for details.
|
|
128
|
+
|
|
96
129
|
## Reduced Package Size
|
|
97
130
|
|
|
98
|
-
This project
|
|
99
|
-
|
|
100
|
-
thanks to code splitting. This helps to greatly reduce the size of the package
|
|
101
|
-
and to make it easier to use in other projects.
|
|
131
|
+
This project has no bundling step. The build copies the `src` folder, which
|
|
132
|
+
holds the generated theme JSON files, to `dist`.
|
|
102
133
|
|
|
103
134
|
## Development
|
|
104
135
|
|
|
105
136
|
This project is built using [Nx](https://nx.dev). As a result, many of the usual
|
|
106
137
|
commands are available to assist in development.
|
|
107
138
|
|
|
139
|
+
To set up a checkout, clone the repository and run `pnpm install` in the
|
|
140
|
+
repository root. Razorwind generates the theme files. Do not edit them by hand.
|
|
141
|
+
Change the token JSON files in `packages/tokens/src/tokens`, then run
|
|
142
|
+
`pnpm nx run monorepo:generate-themes`.
|
|
143
|
+
|
|
108
144
|
### Building
|
|
109
145
|
|
|
110
146
|
Run `nx build shiki` to build the library.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@cyclone-ui/shiki",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.17",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "Cyclone UI Shiki themes package",
|
|
6
6
|
"repository": {
|
|
@@ -14,5 +14,5 @@
|
|
|
14
14
|
"./package.json": "./package.json"
|
|
15
15
|
},
|
|
16
16
|
"publishConfig": { "access": "public" },
|
|
17
|
-
"gitHead": "
|
|
17
|
+
"gitHead": "21d5be9e8232a27e8735270d0109d301f7942a54"
|
|
18
18
|
}
|