npm - @ootc/markdown - Versions diffs - 0.0.8 → 0.0.9 - Mend

@ootc/markdown 0.0.8 → 0.0.9

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.

Files changed (156) hide show

package/README.md CHANGED Viewed

@@ -11,7 +11,9 @@ pnpm add @ootc/markdown
 ## Usage
 ```tsx
-import {MarkdownEditor, MarkdownPreview, CodeBlock} from '@ootc/markdown';
+import {CodeBlock} from '@ootc/markdown/code';
+import {MarkdownPreview} from '@ootc/markdown/preview';
+import {MarkdownEditor} from '@ootc/markdown/editor';
 import '@ootc/markdown/style.css';
 export default function Demo() {
@@ -25,7 +27,14 @@ export default function Demo() {
 }
 ```
-## Components
+## Entrypoints
+- `@ootc/markdown`: minimal surface for code rendering primitives
+- `@ootc/markdown/code`: `CodeBlock`
+- `@ootc/markdown/preview`: `MarkdownPreview`
+- `@ootc/markdown/editor`: `MarkdownEditor`
+`@ootc/markdown/preview` lazy-loads Mermaid only when a rendered document contains a `mermaid` code fence.
 ### MarkdownPreview