Skip to content

Commit acdd115

Browse files
serpentbladeclaude
andcommitted
docs(codemirror): wire comparison into sidebar + reciprocal cross-links
Register 'CodeMirror libraries comparison' in the @rozie-ui/codemirror sidebar block (after the showcase link), mirroring the other five engines. Add reciprocal cross-links between codemirror.md (intro + cross-references) and the new comparison page. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent d346b5c commit acdd115

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,10 @@ export default defineConfig({
126126
},
127127
{
128128
text: '@rozie-ui/codemirror',
129-
items: [{ text: 'CodeMirror — showcase & API', link: '/guide/codemirror' }],
129+
items: [
130+
{ text: 'CodeMirror — showcase & API', link: '/guide/codemirror' },
131+
{ text: 'CodeMirror libraries comparison', link: '/guide/codemirror-comparison' },
132+
],
130133
},
131134
{
132135
text: '@rozie-ui/chartjs',

docs/guide/codemirror.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CodeMirror — the cross-framework code editor
22

3-
`CodeMirror` is Rozie's data-bound port of [CodeMirror 6](https://codemirror.net/) — the de-facto modular code editor for the web. One `.rozie` source file ships idiomatic React, Vue, Svelte, Angular, Solid, and Lit consumers from a single wrapper. Every framework today carries its own hand-maintained CodeMirror binding ([react-codemirror](https://www.npmjs.com/package/@uiw/react-codemirror), [vue-codemirror](https://www.npmjs.com/package/vue-codemirror), [svelte-codemirror](https://www.npmjs.com/package/svelte-codemirror-editor), [ngx-codemirror](https://www.npmjs.com/package/@ctrl/ngx-codemirror)) — each shuttles a `value` through the `EditorView`/`EditorState` API and forwards changes back out. Rozie collapses all of them (plus the Solid and Lit wrappers that **do not exist upstream**) into one source.
3+
`CodeMirror` is Rozie's data-bound port of [CodeMirror 6](https://codemirror.net/) — the de-facto modular code editor for the web. One `.rozie` source file ships idiomatic React, Vue, Svelte, Angular, Solid, and Lit consumers from a single wrapper. Every framework today carries its own hand-maintained CodeMirror binding ([react-codemirror](https://www.npmjs.com/package/@uiw/react-codemirror), [vue-codemirror](https://www.npmjs.com/package/vue-codemirror), [svelte-codemirror](https://www.npmjs.com/package/svelte-codemirror-editor), [ngx-codemirror](https://www.npmjs.com/package/@ctrl/ngx-codemirror)) — each shuttles a `value` through the `EditorView`/`EditorState` API and forwards changes back out. Rozie collapses all of them (plus the Solid and Lit wrappers that **do not exist upstream**) into one source. See the [CodeMirror libraries comparison](/guide/codemirror-comparison) for the full per-framework matrix — including the Angular wrapper that's still on CodeMirror 5.
44

55
This page is the **show-and-tell**: the API surface, per-framework quick starts, the imperative handle, the consumer-extensible `:extensions` passthrough, and the per-target recipe for the one `panel` portal slot.
66

@@ -378,6 +378,7 @@ CodeMirror 6 has many extension-mounted injection points (tooltips, gutter marke
378378

379379
## Cross-references
380380

381+
- [CodeMirror libraries comparison](/guide/codemirror-comparison) — the per-framework wrapper matrix, the CM5-vs-CM6 Angular split, and Rozie's own gap status.
381382
- [`CodeMirror.rozie` source on GitHub](https://github.com/One-Learning-Community/rozie.js/blob/main/packages/ui/codemirror/src/CodeMirror.rozie) — the canonical wrapper.
382383
- [The portal-slot primitive](/examples/portal-list) — how `<slot name="X" portal />` routes a consumer fragment through each target's imperative-render API.
383384
- [`$expose` and the imperative handle](/guide/features#expose-→-a-consumer-callable-imperative-handle-everywhere)

0 commit comments

Comments
 (0)