seemore 1.6.0 → 1.6.1
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 +14 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,7 +47,7 @@ AI tools write Markdown — specs, notes, guides, READMEs, whole folders of it,
|
|
|
47
47
|
**seemore** points at that folder and renders it as a proper site instead, without you moving a single file or writing any code.
|
|
48
48
|
|
|
49
49
|
<p align="center">
|
|
50
|
-
<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
|
|
50
|
+
<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"/>
|
|
51
51
|
</p>
|
|
52
52
|
|
|
53
53
|
Three ways to use it:
|
|
@@ -58,6 +58,19 @@ Three ways to use it:
|
|
|
58
58
|
|
|
59
59
|
And whichever preview is open, the page is also an editor: **double-click any paragraph to fix its Markdown in place**, and the change is written straight back to the file.
|
|
60
60
|
|
|
61
|
+
## Who is seemore for?
|
|
62
|
+
|
|
63
|
+
If your documentation is a folder of Markdown files, seemore helps you browse, review, edit and publish it with almost no setup.
|
|
64
|
+
|
|
65
|
+
Typical use cases include:
|
|
66
|
+
|
|
67
|
+
- **Review AI-generated documentation** — when you're buried under AI-written Markdown and need a faster way to browse, search and edit it instead of opening files one by one.
|
|
68
|
+
- **Present documentation** — turn a folder of Markdown into a polished website for teammates, clients or the public without moving files into another system.
|
|
69
|
+
- **Zero-setup documentation** — point seemore at an existing folder and it just works, with no migration, configuration or project structure to learn.
|
|
70
|
+
- **Project documentation** — READMEs, architecture docs, RFCs, API documentation, specifications and engineering handbooks.
|
|
71
|
+
- **Documentation review** — read rendered pages instead of raw Markdown while making fixes directly from the preview.
|
|
72
|
+
- **Static documentation sites** — publish the same Markdown with `seemore build` instead of maintaining a separate documentation stack.
|
|
73
|
+
|
|
61
74
|
## Features
|
|
62
75
|
|
|
63
76
|
- **Zero config** — no config file, no code, no files to move; a plain folder of Markdown works in the browser, in your editor, and as a static build
|