feat: rename components to Markdown and MarkdownParsed - #313
Merged
Conversation
Component names now describe what they render instead of carrying the library brand: - `Comark` -> `Markdown` (raw markdown source in, parsed and rendered) - `ComarkRenderer` -> `MarkdownParsed` (renders an already-parsed document) - `ComarkClient`/`ComarkLive` (React) -> `MarkdownClient`/`MarkdownLive` - `ComarkAsync`/`ComarkNode` (Svelte) -> `MarkdownAsync`/`MarkdownNode` - Angular classes -> `Markdown`/`MarkdownParsed`/`MarkdownNode` with prefixed selectors (`comark-markdown`, `comark-markdown-parsed`, `comark-markdown-node`) - `defineComarkComponent` -> `defineMarkdownComponent`, `defineComarkRendererComponent` -> `defineMarkdownParsedComponent` - `markdown`/`tree` props -> `value` All old names and props keep working as deprecated aliases with a one-time dev-only console warning. The Comark brand, package names, and parser APIs are unchanged. Examples, docs, skills, and READMEs migrated; migration note added at docs/content/7.kb/5.renamed-components.md.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
comark
@comark/angular
@comark/ansi
@comark/html
@comark/nuxt
@comark/react
@comark/svelte
@comark/vue
commit: |
farnabaz
approved these changes
Jul 30, 2026
This was referenced Aug 3, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Linked issue
N/A
❓ Type of change
📚 Description
Renames Comark's public components across every framework package so component names describe what they render, not the library. The Comark brand stays for the project, packages, and parser APIs.
Renames
ComarkMarkdownComarkRendererMarkdownParsedComarkClient/ComarkLive(React)MarkdownClient/MarkdownLiveComarkAsync/ComarkNode(Svelte)MarkdownAsync/MarkdownNodeComarkComponent/ComarkRendererComponent/ComarkNodeComponent(Angular)Markdown/MarkdownParsed/MarkdownNodecomark/comark-renderer/comark-nodecomark-markdown/comark-markdown-parsed/comark-markdown-nodedefineComarkComponent/defineComarkRendererComponentdefineMarkdownComponent/defineMarkdownParsedComponentComarkProps/ComarkRendererProps/ …MarkdownProps/MarkdownParsedProps/ …markdown/treevalueTarget usage:
Backward compatibility (non-breaking)
markdown/treeprops keep working as deprecated aliases (@deprecatedJSDoc pointing to the new name).internal/deprecation.tshelper per package../components/*subpaths are preserved: old.sveltefiles remain as thin deprecated wrappers.Markdown,MarkdownParsed) and old names.Scope
@comark/vue,@comark/react,@comark/svelte,@comark/angular,@comark/nuxt(+ JSDoc-only touches incomarkcore)examples/1.frameworks,2.vite,3.plugins,4.ai) and benchmarks migrated to the new namesdocs/content/7.kb/5.renamed-components.md(no page slugs changed, so no redirects needed)README.md, package READMEs, andAGENTS.mdupdatedpackages/comark-vue/test/deprecated-aliases.test.ts,packages/comark-react/test/deprecated-aliases.test.tsxVerification
pnpm build✅ (all packages)wrapped-pre-highlighted.mdfailures are pre-existing onmainpnpm typecheck— remaining 4 errors are identical onmain(pre-existing, unrelated)pnpm lint✅rg '<Comark|ComarkRenderer'— remaining hits are only deprecated alias definitions, alias tests, the migration note, and changelog history📝 Checklist
pnpm verifyand it passes.