seemore 1.12.4 → 1.12.5
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 +10 -5
- package/package.json +1 -1
- package/src/app/entry.prerender.tsx +10 -1
package/README.md
CHANGED
|
@@ -1,19 +1,18 @@
|
|
|
1
1
|
<br/>
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<img src="https://raw.githubusercontent.com/arifszn/seemore/main/assets/
|
|
5
|
-
<h1 align="center">seemore</h1>
|
|
4
|
+
<img src="https://raw.githubusercontent.com/arifszn/seemore/main/assets/logo.png" alt="seemore" width="280">
|
|
6
5
|
<h4 align="center">Let AI write the Markdown. Let seemore show it better — zero config documentation framework.</h4>
|
|
7
6
|
<p align="center">
|
|
8
7
|
<a href="https://www.npmjs.com/package/seemore">
|
|
9
8
|
<img src="https://img.shields.io/npm/v/seemore"/>
|
|
10
9
|
</a>
|
|
11
|
-
<a href="https://marketplace.visualstudio.com/items?itemName=arifszn.seemore-vscode">
|
|
12
|
-
<img src="https://img.shields.io/badge/VS_Code-Marketplace-007ACC?logo=visualstudiocode&logoColor=white"/>
|
|
13
|
-
</a>
|
|
14
10
|
<a href="https://open-vsx.org/extension/arifszn/seemore-vscode">
|
|
15
11
|
<img src="https://img.shields.io/badge/Open_VSX-Registry-C160EF?logo=eclipseide&logoColor=white"/>
|
|
16
12
|
</a>
|
|
13
|
+
<a href="https://marketplace.visualstudio.com/items?itemName=arifszn.seemore-vscode">
|
|
14
|
+
<img src="https://img.shields.io/badge/VS_Code-Marketplace-007ACC?logo=visualstudiocode&logoColor=white"/>
|
|
15
|
+
</a>
|
|
17
16
|
<a href="https://github.com/arifszn/seemore/actions/workflows/ci.yml">
|
|
18
17
|
<img src="https://github.com/arifszn/seemore/actions/workflows/ci.yml/badge.svg"/>
|
|
19
18
|
</a>
|
|
@@ -39,6 +38,12 @@ A folder of `.md` files has no order. You cannot click a link between files. You
|
|
|
39
38
|
|
|
40
39
|
**seemore** points at that folder and renders it as a real site. It does not move your files. It does not need any code.
|
|
41
40
|
|
|
41
|
+
## Why seemore?
|
|
42
|
+
|
|
43
|
+
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.
|
|
44
|
+
|
|
45
|
+
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.
|
|
46
|
+
|
|
42
47
|
<p align="center">
|
|
43
48
|
<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"/>
|
|
44
49
|
</p>
|
package/package.json
CHANGED
|
@@ -83,7 +83,16 @@ function renderToHtml(element: ReactNode): Promise<{ html: string; failures: unk
|
|
|
83
83
|
});
|
|
84
84
|
}
|
|
85
85
|
|
|
86
|
-
/**
|
|
86
|
+
/**
|
|
87
|
+
* Components an MDX file can use without importing anything.
|
|
88
|
+
*
|
|
89
|
+
* Adding one that hides or defers content by default (as `CodeBlockTabs` does — Radix
|
|
90
|
+
* mounts only the active panel) needs the export path updated in the same change, or the
|
|
91
|
+
* new content goes missing from every exported file the way the tabs did:
|
|
92
|
+
* `exportComponents` below, which force-mounts it for the prerender; `captureTabPanels` in
|
|
93
|
+
* `exportPage.ts`, which harvests it for the browser export; and the runtime that wires the
|
|
94
|
+
* static markup back up (`RUNTIME` in `exportPage.ts`, `bindBehaviors` in `standalone.ts`).
|
|
95
|
+
*/
|
|
87
96
|
const PROVIDED_COMPONENTS = 'Callout, Card, Cards, CodeBlockTabs, Mermaid, D2 and Pdf';
|
|
88
97
|
|
|
89
98
|
/**
|