seemore 1.12.10 → 1.12.12

package/README.md

@@ -36,13 +36,7 @@ AI tools write Markdown fast. They write specs, notes, guides, READMEs, and whol
 
 A folder of `.md` files has no order. You cannot click a link between files. You cannot search across them.
 
-**seemore** points at that folder and renders it as a real site. It does not move your files. It does not need any code.
-
-## Why seemore?
-
-Modern libraries can generate HTML, but that is not the same as previewing an existing project. seemore lets you view a folder of Markdown, such as a wiki or a notes folder, in the browser as a real site, without rewriting it, adding a build pipeline, or asking every teammate to learn HTML.
-
-That is the value of zero configuration: you open the project and see it as intended. If you stop using seemore, your files stay exactly where they are. There is nothing to clean up.
+**seemore** points at that folder and renders it as a real site. Other docs frameworks need a project first: a scaffold, a config file, a `docs/` layout, and a build step in your repo. seemore needs only a folder that already exists. It does not move your files, and it does not need any code. If you stop using seemore, your files stay where they are.
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/home.png" alt="The seemore site: a terminal typing npx seemore to serve a folder of notes at localhost:4040, with an arrow pointing to the browser preview" width="640"/>
@@ -50,16 +44,14 @@ That is the value of zero configuration: you open the project and see it as inte
 
 ## Quick start
 
-seemore needs [Node.js](https://nodejs.org) 20 or newer. You do not install anything. You do not write a config file. You do not move any files.
+seemore needs [Node.js](https://nodejs.org) 20 or newer.
 
 ```bash
 cd my-docs
 npx seemore   # renders this folder at http://localhost:4040
 ```
 
-`npx seemore` runs seemore without adding it to your project's dependencies.
-
-Open the address it prints. The site stays live after that. Add, rename, retitle, or delete a file, and the site updates at once. Navigation and search update too.
+`npx seemore` runs seemore without adding it to your dependencies. Open the address it prints. Add, rename, retitle, or delete a file, and the site updates at once. Navigation and search update too.
 
 The [seemore website](https://arifszn.github.io/seemore) is a folder of Markdown, rendered by seemore. Your own folder will look the same way.
 
@@ -106,22 +98,16 @@ Or call the skill by name:
 
 </details>
 
-## Three ways to use it
-
-- **[In your browser](#edit-from-the-browser)**: `npx seemore` serves the folder you are in. The site updates live as you edit.
-- **[In your code editor](#view-in-your-code-editor)**: an extension shows the same site in a panel next to your file, in VS Code and VS Code-compatible editors like Cursor and Antigravity.
-- **[As a static site](#publish-it-to-the-web)**: `npx seemore build` exports plain HTML you can host anywhere. seemore is a docs framework, not only a preview tool.
-
 <p align="center">
-  <video src="https://github.com/user-attachments/assets/f4765a06-980e-4f24-9194-198e6dbaec90" width="640" controls muted></video>
+  <video src="https://github.com/user-attachments/assets/dd8280d2-fc8a-47c9-b2db-b1a1ccde81ce" width="640" controls muted></video>
 </p>
 
 ## What you get
 
 Point seemore at any Markdown you already have: AI-written notes, project docs, RFCs, API references, specs, or an engineering handbook. You get:
 
-- **Zero config**: no config file, no code, no files to move. A plain folder works in the browser, in your editor, and as a static build
-- **Live preview**: files appear, disappear and reorder as you edit them. Navigation and search update too
+- **Zero config**: no config file, no code, no files to move
+- **Live preview**: files appear, disappear and reorder as you edit them
 - **Edit in place**: double-click any block in the preview to fix its Markdown
 - **Editor integration**: one extension covers VS Code, Cursor, Antigravity and other VS Code-compatible editors, including remote workspaces
 - **Documentation framework**: `seemore build` renders the whole site to HTML, ready to deploy on any host
@@ -132,12 +118,6 @@ Point seemore at any Markdown you already have: AI-written notes, project docs,
 - **Full MDX**: `.mdx` pages take real JSX, your own React components and CSS
 - **12 themes**: dark and light follow the system, with a toggle that remembers your choice. Your own CSS always wins
 
-### How seemore is different
-
-- **Starts where your files already are**: most docs frameworks need a project, with a scaffold, a config file, a `docs/` layout and a build step wired into your repo. seemore needs only a folder that already exists.
-- **Preview first, site generator second**: the same content serves locally, renders beside your editor, and builds to static HTML. No separate setup is needed for each one.
-- **Nothing to migrate, nothing to undo**: seemore never moves or rewrites your files. You can stop using it at any time, at no cost.
-
 ## Edit from the browser
 
 The preview is also an editor. Double-click any paragraph, heading, list item, quote or table cell. A small editor opens with that block's **Markdown source**: `**bold**` stays `**bold**`, links stay links, tables stay tables. Fix the text, press **Save**, and seemore writes the change to the file on disk.
@@ -150,7 +130,7 @@ Inline editing works only for local previews.
 
 ## View in your code editor
 
-Install **seemore** from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=arifszn.seemore-vscode) or [Open VSX](https://open-vsx.org/extension/arifszn/seemore-vscode). You get the same rendered site as a panel beside your editor, with no terminal, no `npx` and no browser tab to manage. The extension bundles the CLI, so nothing downloads and nothing goes on your PATH. Open VSX also covers VS Code-compatible editors such as Cursor and Antigravity.
+Install **seemore** from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=arifszn.seemore-vscode) or [Open VSX](https://open-vsx.org/extension/arifszn/seemore-vscode). You get the same rendered site as a panel beside your editor, with no terminal and no browser tab to manage. The extension bundles the CLI, so nothing downloads and nothing goes on your PATH.
 
 <p align="center">
   <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/vscode-extension.png" alt="VS Code with features.md open in the editor and the seemore panel beside it, rendering the same page with a paragraph's Markdown source open in the inline editor" width="640"/>
@@ -166,7 +146,7 @@ Install **seemore** from the [VS Code Marketplace](https://marketplace.visualstu
 npx seemore build  # static export to dist/ for any host
 ```
 
-The result is a `dist/` folder of plain web files. Drop it on [Netlify](https://netlify.com), [Surge](https://surge.sh), [Cloudflare Pages](https://pages.cloudflare.com) or [GitHub Pages](https://pages.github.com), or hand it to any web host. Every page is a separate `index.html`, next to a `404.html` that every static host reads. seemore also writes the files each host needs (`_redirects`, `200.html`, `.nojekyll`).
+The result is a `dist/` folder of plain web files. Drop it on [Netlify](https://netlify.com), [Surge](https://surge.sh), [Cloudflare Pages](https://pages.cloudflare.com) or [GitHub Pages](https://pages.github.com), or hand it to any web host.
 
 > [!TIP]
 > Do you publish to GitHub Pages at `username.github.io/my-repo/`, not at the root? Set the subpath once with `base: '/my-repo/'`.
@@ -179,27 +159,15 @@ Add `auth: true` to `seemore.config.ts`. Set the password when you build:
 SEEMORE_PASSWORD='a-long-passphrase' npx seemore build
 ```
 
-On Windows PowerShell:
-
-```powershell
-$env:SEEMORE_PASSWORD='a-long-passphrase'; npx seemore build
-```
-
 <p align="center">
   <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/password-protection.png" alt="The lock screen of a password-protected seemore site: the site's icon and title above a password field and an Unlock button" width="560"/>
 </p>
 
-By default, a visitor stays unlocked for one day after their last visit. Change this with `remember`:
-
-```ts
-auth: { remember: '7d' } // or '12h'
-```
-
-Password protection works only for `seemore build`. To test the lock screen, build the site and serve `dist/` on `localhost`.
+seemore encrypts the site content, so nobody can read a copy of the build without the password. A short password can be guessed offline, so use a long one.
 
 ### Share a single page to Slack, email
 
-To share one page instead of a site, use the **Actions** button above the page. It writes one self-contained HTML file (styles inlined, images embedded, diagrams kept) that opens offline from a double-click. The CLI does the same without a browser:
+To share one page instead of a site, use the **Actions** button above the page. It writes one self-contained HTML file that opens offline from a double-click. The CLI does the same without a browser:
 
 ```bash
 npx seemore export docs/spec.md   # writes spec.html next to the Markdown
@@ -232,28 +200,7 @@ export default {
 };
 ```
 
-`features` is a set of switches. Name only the flags you want to change. Every other flag keeps its default value.
-
-| Flag | Default | Effect |
-| --- | --- | --- |
-| `navigation.instant.prefetch` | on | Load the target page on hover |
-| `navigation.instant.preview` | off | Hover popover showing the target page |
-| `navigation.footer` | on | Previous and next page links. The `footer` key controls the site footer. |
-| `navigation.top` | on | Back-to-top button |
-| `navigation.path` | off | Breadcrumbs |
-| `navigation.sections` | off | Top-level entries as sidebar groups |
-| `navigation.prune` | off | Render only the visible subtree |
-| `toc.follow` | on | Keep the active heading visible |
-| `toc.integrate` | off | Merge the table of contents into the sidebar |
-| `content.code.copy` | on | Copy button on code blocks |
-| `content.action.edit` | on with `editLink` | Edit-this-page link |
-| `content.edit` | on (dev only) | Double-click a block to edit its Markdown in place |
-| `content.image.zoom` | on | Click-to-zoom on content images |
-| `search.suggest` | on | Inline query completion |
-| `search.highlight` | on | Highlight the query on the page you land on |
-| `social.cards` | off | Per-page OG images (needs `takumi-js`) |
-
-The [configuration](https://arifszn.github.io/seemore/configuration) and [features](https://arifszn.github.io/seemore/features) pages document every key above.
+`features` is a set of switches for breadcrumbs, prefetching, the table of contents, code-block buttons and more. Name only the flags you want to change. Every other flag keeps its default value. The [configuration](https://arifszn.github.io/seemore/configuration) and [features](https://arifszn.github.io/seemore/features) pages document every key.
 
 ### Themes
 
@@ -267,23 +214,13 @@ The [themes page](https://arifszn.github.io/seemore/themes) shows all twelve.
 
 ## Content
 
-Works with both `.md` and `.mdx`.
-
-- GitHub Flavoured Markdown, admonitions (note, tip and warning boxes), step-by-step lists, and colour-highlighted code blocks with optional filenames and line numbers
-- `[[wikilinks]]`, including `[[Page|label]]` and `[[Page#Heading]]`. Use these to link pages without getting relative paths right. Plain relative `.md` links also resolve automatically
-- **[Mermaid](https://mermaid.js.org)** and **[D2](https://d2lang.com)** diagrams, rendered live in the browser from a ` ```mermaid ` or ` ```d2 ` code fence
-- Sibling images, inlined as hashed assets with click-to-zoom, and PDFs, opened inline in the browser's own viewer
-- Page order comes from a `meta.json` file, a frontmatter `order` field, or the title, checked in that order
+Works with both `.md` and `.mdx`. **[Mermaid](https://mermaid.js.org)** and **[D2](https://d2lang.com)** diagrams render live in the browser, straight from a ` ```mermaid ` or ` ```d2 ` code fence:
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/diagrams.png" alt="A mermaid flowchart reading Markdown, seemore, Static site rendered live on the Diagrams page, with a D2 diagram of the same chain below it" width="640"/>
+  <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/diagrams.png" alt="A mermaid code fence on the Diagrams page, with the flowchart it produces below: folder of .md into seemore, then a live site and static HTML" width="640"/>
 </p>
 
-The [content page](https://arifszn.github.io/seemore/content) renders every syntax above, live.
-
-### PDF viewer
-
-Reference a PDF with image syntax. Use a sibling file or a remote URL. The PDF opens inline, with a download link underneath:
+Reference a PDF with image syntax, and it opens inline with a download link underneath:
 
 ```md
 ![sample document](./assets/sample.pdf)
@@ -293,6 +230,8 @@ Reference a PDF with image syntax. Use a sibling file or a remote URL. The PDF o
   <img src="https://raw.githubusercontent.com/arifszn/seemore/main/packages/site/assets/pdf-viewer.png" alt="A sample PDF rendered inline on the page in the browser's native PDF viewer, with a Download sample document link underneath" width="640"/>
 </p>
 
+Page order comes from a `meta.json` file, a frontmatter `order` field, or the title, checked in that order. The [content page](https://arifszn.github.io/seemore/content) renders every syntax seemore supports, live.
+
 ## CLI
 
 ```
@@ -305,15 +244,11 @@ Run `seemore --help` to see the options, or see the [CLI reference](https://arif
 
 ## FAQ
 
-**Do I have to install anything?** No. Just run `npx seemore`.
-
 **Does anything leave my machine?** No. The dev server, the build and the export all run locally, with no account and no telemetry. The only network calls are ones you configure yourself, such as a hosted search provider.
 
 **Does seemore move or rewrite my files?** No. seemore reads your folder in place. It writes to a file only when you save an inline edit, or run `build` or `export`.
 
-**Is the password protection real?** Yes. seemore encrypts the site content, so nobody can read a copy of the build without the password. There is no per-person access and no way to revoke one password alone. A short password can be guessed offline, so use a long one.
-
-**Is seemore a preview tool or a docs framework?** Both, from the same folder: `seemore` previews it, the extension renders it beside your editor, and `seemore build` publishes it.
+**Is the password protection real?** Yes. The content is encrypted at build time. There is no per-person access, and no way to revoke one password alone.
 
 ## Under the hood
 

package/dist/cli/index.js

@@ -1451,6 +1451,24 @@ function rehypeSeemorePositions() {
   };
 }
 
+// src/node/vite/raw.ts
+import rehypeRaw from "rehype-raw";
+var MDX_NODE_TYPES = [
+  "mdxFlowExpression",
+  "mdxJsxFlowElement",
+  "mdxJsxTextElement",
+  "mdxTextExpression",
+  "mdxjsEsm"
+];
+function rehypeSeemoreRawHtml() {
+  const transform = rehypeRaw({ passThrough: [...MDX_NODE_TYPES] });
+  return (tree, file) => {
+    const path = file.path ?? "";
+    if (!/\.md(?:$|\?)/.test(path)) return tree;
+    return transform(tree, file);
+  };
+}
+
 // src/node/vite/mdx.ts
 var MARKDOWN_EXPORT = "_markdown";
 function createRemarkPlugins(options) {
@@ -1501,7 +1519,13 @@ function createRehypePlugins(options = {}) {
     rehypeToc,
     // After `rehype-code`, so a fence Shiki rebuilt is passed over rather than stamped with
     // the position of whatever it replaced.
-    ...options.positions === true ? [rehypeSeemorePositions] : []
+    ...options.positions === true ? [rehypeSeemorePositions] : [],
+    // Last, and deliberately. `rehype-raw` reparses the whole document to stitch raw HTML
+    // back together, which costs every node its `data` — including the fence meta
+    // `rehype-code` reads `noCopy` from. Running it here means each plugin above has already
+    // taken what it needs, and the elements it creates are not stamped as editable, which is
+    // right: they have no source range a text editor could be handed.
+    rehypeSeemoreRawHtml
   ];
 }