@wipcomputer/markdown-viewer 1.0.1 → 1.0.2
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/package.json
CHANGED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: markdown-viewer
|
|
3
|
+
description: Live markdown viewer with SSE reload. Works in all browsers including Safari. Zero dependencies.
|
|
4
|
+
homepage: https://github.com/wipcomputer/wip-markdown-viewer
|
|
5
|
+
metadata:
|
|
6
|
+
{
|
|
7
|
+
"openclaw":
|
|
8
|
+
{
|
|
9
|
+
"emoji": "📝",
|
|
10
|
+
"requires": { "bins": ["node"] },
|
|
11
|
+
"install":
|
|
12
|
+
[
|
|
13
|
+
{
|
|
14
|
+
"id": "npm",
|
|
15
|
+
"kind": "npm",
|
|
16
|
+
"package": "@wipcomputer/markdown-viewer",
|
|
17
|
+
"global": true,
|
|
18
|
+
"bins": ["mdview"],
|
|
19
|
+
"label": "Install markdown-viewer (npm)",
|
|
20
|
+
},
|
|
21
|
+
],
|
|
22
|
+
},
|
|
23
|
+
}
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
# Live Markdown Viewer
|
|
27
|
+
|
|
28
|
+
See your documents update in real time as your AI edits them.
|
|
29
|
+
|
|
30
|
+
## Quick start
|
|
31
|
+
|
|
32
|
+
Start the server:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
curl -s http://127.0.0.1:3000/ > /dev/null 2>&1 || mdview &
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Open a file:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## How it works
|
|
45
|
+
|
|
46
|
+
1. Tell your AI coding tool to install `@wipcomputer/markdown-viewer` globally
|
|
47
|
+
2. Tell your AI to open a .md file in md view
|
|
48
|
+
3. AI opens the file in your default browser
|
|
49
|
+
4. Every save re-renders the page instantly. No refresh needed.
|
|
50
|
+
|
|
51
|
+
Open multiple tabs to work on multiple documents at once.
|
|
52
|
+
|
|
53
|
+
## Features
|
|
54
|
+
|
|
55
|
+
- SSE-powered live reload (works in Safari, Chrome, Firefox)
|
|
56
|
+
- Multi-file support (each tab watches its own file)
|
|
57
|
+
- GitHub Flavored Markdown (tables, task lists, strikethrough)
|
|
58
|
+
- Syntax highlighting (180+ languages)
|
|
59
|
+
- Dark mode
|
|
60
|
+
- Table of contents
|
|
61
|
+
- Mermaid diagrams
|
|
62
|
+
- KaTeX math equations
|
|
63
|
+
|
|
64
|
+
## Notes
|
|
65
|
+
|
|
66
|
+
- The `open` command works on macOS. On Linux use `xdg-open`. On Windows use `start`.
|
|
67
|
+
- Server runs at `http://127.0.0.1:3000` by default. Use `mdview --port 8080` to change.
|
|
68
|
+
- Zero npm dependencies. Pure Node.js.
|