@suzumiyaaoba/mdxr 0.4.0 → 0.6.0
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/README.md +6 -0
- package/dist/cli.mjs +231 -433
- package/dist/components.d.mts +3 -3
- package/dist/components.mjs +2 -2
- package/dist/{config-DQeZaek7.mjs → config-C-pcUAoU.mjs} +1 -1
- package/dist/{doc-context-B_H-VT1p.d.mts → doc-context-CWOZ0eDq.d.mts} +7 -1
- package/dist/index.d.mts +1 -1
- package/dist/index.mjs +2 -2
- package/dist/{ui-D89i0Cq-.mjs → ui-k-VrmhPJ.mjs} +268 -51
- package/package.json +3 -2
- package/skill/references/components/output.md +3 -1
- package/skill/references/components/reports.md +60 -0
- package/skill/references/components.md +2 -0
- package/src/annotation-html.ts +60 -0
- package/src/annotations.ts +224 -0
- package/src/ascii/index.ts +2 -0
- package/src/ascii/research.ts +90 -0
- package/src/assets/annotations.css +502 -0
- package/src/assets/css.ts +36 -1
- package/src/client/annotation-anchors.ts +270 -0
- package/src/client/annotation-view.ts +224 -0
- package/src/client/annotations.ts +582 -0
- package/src/client/doc-events.ts +1 -1
- package/src/client/entry.ts +2 -0
- package/src/html.ts +5 -21
- package/src/hydrate/runtime-module.ts +0 -1
- package/src/hydrate.ts +0 -5
- package/src/mdx.ts +5 -4
- package/src/remark/annotation-sources.ts +64 -0
- package/src/remark/directives.ts +2 -0
- package/src/remark/headings.ts +1 -23
- package/src/remark/include.ts +7 -0
- package/src/remark/references.ts +37 -10
- package/src/render.ts +8 -51
- package/src/research.ts +147 -0
- package/src/tailwind.ts +1 -0
- package/src/ui/graph-viewport.tsx +52 -0
- package/src/ui/graph.tsx +35 -28
- package/src/ui/index.ts +6 -0
- package/src/ui/performance-target.tsx +48 -0
- package/src/ui/research-claim.tsx +69 -0
- package/src/components/ui/toc.tsx +0 -560
- package/src/page-toc-js.ts +0 -46
- package/src/page-toc-runtime.ts +0 -22
- package/src/ui/page-toc.tsx +0 -54
package/README.md
CHANGED
|
@@ -37,6 +37,12 @@ mdxr render plan.mdx --format json # machine-readable errors
|
|
|
37
37
|
|
|
38
38
|
Preview a document in the browser with live reload (`-p, --port`, default `3737`; `--open` to launch the browser once serving).
|
|
39
39
|
|
|
40
|
+
### Review the rendered document
|
|
41
|
+
|
|
42
|
+
Select text and click **Add comment**, or open **Annotate → Select figure** to comment on an image, diagram, or chart. Edit or delete comments in the panel, then **Copy Markdown** to send the quoted targets, source locations, and feedback to a coding agent.
|
|
43
|
+
|
|
44
|
+
Saved annotations remain in your browser for that document; they do not modify the source file or travel with the HTML. If the document changes, targets that cannot be identified keep their original quotes and are marked unavailable. [Review annotations](https://suzumiyaaoba.com/mdxr/annotations) describes keyboard shortcuts, storage, and clipboard fallbacks.
|
|
45
|
+
|
|
40
46
|
### `mdxr text [file]`
|
|
41
47
|
|
|
42
48
|
Render an `.mdx` document to plain Markdown — every component becomes an ASCII/text stand-in (status checkbox lists, block-bar charts, GFM tables, `<details>` disclosures) so the document stays readable in any Markdown viewer or terminal. Interactive-only widgets (dialogs, menus, shadcn chrome) degrade to their text content; unknown components warn to stderr and keep their children.
|