@wipcomputer/markdown-viewer 1.0.5 → 1.0.6
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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wipcomputer/markdown-viewer",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.6",
|
|
4
4
|
"description": "Live markdown viewer for AI pair-editing. When you collaborate, the updates render instantly. Works with any AI agent and web browser.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "server.js",
|
|
@@ -7,7 +7,7 @@ metadata:
|
|
|
7
7
|
"openclaw":
|
|
8
8
|
{
|
|
9
9
|
"emoji": "📝",
|
|
10
|
-
"requires": { "bins": ["node"] },
|
|
10
|
+
"requires": { "bins": ["node", "curl"] },
|
|
11
11
|
"install":
|
|
12
12
|
[
|
|
13
13
|
{
|
|
@@ -25,20 +25,37 @@ metadata:
|
|
|
25
25
|
|
|
26
26
|
# Live Markdown Viewer
|
|
27
27
|
|
|
28
|
-
|
|
28
|
+
Live markdown viewer for AI pair-editing. When you collaborate, the updates render instantly. Works with any AI agent and web browser.
|
|
29
|
+
|
|
30
|
+
## Install
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
npm install -g @wipcomputer/markdown-viewer
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
This installs the `mdview` command globally. Zero runtime dependencies. Pure Node.js.
|
|
37
|
+
|
|
38
|
+
Source: [github.com/wipcomputer/wip-markdown-viewer](https://github.com/wipcomputer/wip-markdown-viewer)
|
|
29
39
|
|
|
30
40
|
## Quick start
|
|
31
41
|
|
|
32
|
-
Start the server:
|
|
42
|
+
Start the server (binds to 127.0.0.1 only, never exposed to the network):
|
|
33
43
|
|
|
34
44
|
```bash
|
|
35
45
|
curl -s http://127.0.0.1:3000/ > /dev/null 2>&1 || mdview &
|
|
36
46
|
```
|
|
37
47
|
|
|
38
|
-
Open a file:
|
|
48
|
+
Open a file in your default browser:
|
|
39
49
|
|
|
40
50
|
```bash
|
|
51
|
+
# macOS
|
|
41
52
|
open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"
|
|
53
|
+
|
|
54
|
+
# Linux
|
|
55
|
+
xdg-open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"
|
|
56
|
+
|
|
57
|
+
# Windows
|
|
58
|
+
start "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"
|
|
42
59
|
```
|
|
43
60
|
|
|
44
61
|
## How it works
|
|
@@ -50,6 +67,12 @@ open "http://127.0.0.1:3000/view?path=/absolute/path/to/file.md"
|
|
|
50
67
|
|
|
51
68
|
Open multiple tabs to work on multiple documents at once.
|
|
52
69
|
|
|
70
|
+
## Security
|
|
71
|
+
|
|
72
|
+
- Server binds to `127.0.0.1` only. It is not accessible from other machines.
|
|
73
|
+
- The `/view?path=` parameter reads files from your local filesystem. This is expected behavior for a local viewer. Do not expose the port to untrusted networks.
|
|
74
|
+
- Zero npm dependencies. No supply chain risk beyond Node.js itself.
|
|
75
|
+
|
|
53
76
|
## Features
|
|
54
77
|
|
|
55
78
|
- SSE-powered live reload (works in Safari, Chrome, Firefox)
|
|
@@ -63,6 +86,5 @@ Open multiple tabs to work on multiple documents at once.
|
|
|
63
86
|
|
|
64
87
|
## Notes
|
|
65
88
|
|
|
66
|
-
- The `open` command works on macOS. On Linux use `xdg-open`. On Windows use `start`.
|
|
67
89
|
- Server runs at `http://127.0.0.1:3000` by default. Use `mdview --port 8080` to change.
|
|
68
|
-
-
|
|
90
|
+
- The server does not survive reboots. The curl check in quick start restarts it if needed.
|