@suzumiyaaoba/mdxr 0.6.0 → 0.8.0

package/README.md

@@ -43,6 +43,8 @@ Select text and click **Add comment**, or open **Annotate → Select figure** to
 
 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.
 
+Each document-level `##` section also has a **Not reviewed / Reviewed** toggle. Review status is saved locally per document and restored after reload; sections with changed content require review again. In **Pages** view, the sidebar shows section statuses and review progress. See [Section review status](https://suzumiyaaoba.com/mdxr/authoring#section-review-status).
+
 ### `mdxr text [file]`
 
 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.
@@ -70,6 +72,23 @@ mdxr init --global         # into your home directory instead
 
 Local installs also add `.mdxr/` to the project's `.gitignore` — the untracked scratch dir agents write documents to.
 
+## Wireframes
+
+Build screen mockups with the built-in `Wireframe*` components, adapted from [wireframe-ui](https://wireframe-ui.vercel.app/components). All 45 upstream UI families and nine blocks are included, with their compound parts and wireframe helpers. No imports or extra installation are needed in MDX:
+
+```mdx
+<Wireframe title="Sign in" device="mobile">
+  <WireframeStack>
+    <WireframeHeading>Welcome back</WireframeHeading>
+    <WireframeInput label="Email" type="email" />
+    <WireframeInput label="Password" type="password" />
+    <WireframeButton>Sign in</WireframeButton>
+  </WireframeStack>
+</Wireframe>
+```
+
+Render with `mdxr render wireframe.mdx`. Text/media placeholders, cards, avatars, lists, section presets, and editable fields support light/dark themes and Markdown output. See the [guide](docs/docs/wireframe.mdx) and [examples](examples/catalog/wireframe.mdx). Adapted source retains the [upstream MIT license](src/wireframe-ui.LICENSE.md).
+
 ## Agent skill
 
 The `mdxr` skill teaches coding agents the component catalog and the render workflow. Install it into your project (or globally) with the [`skills` CLI](https://github.com/vercel-labs/skills):