pageproof 0.1.1 → 0.1.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/CHANGELOG.md +13 -0
- package/assets/SKILL.md +30 -25
- package/package.json +2 -1
package/CHANGELOG.md
ADDED
package/assets/SKILL.md
CHANGED
|
@@ -10,49 +10,54 @@ file. It handles footnotes and citations, and reloads automatically when the sou
|
|
|
10
10
|
|
|
11
11
|
## Opening a preview
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
Always invoke in detached mode so the shell returns once the preview is up:
|
|
13
|
+
When the user asks to preview a Markdown document, invoke this comment:
|
|
15
14
|
```sh
|
|
16
15
|
pageproof --detached "FILE.md"
|
|
17
16
|
```
|
|
18
|
-
It will
|
|
19
|
-
|
|
17
|
+
It will start an HTTP server on a random localhost port, and open a browser tab.
|
|
18
|
+
On WSL, it will use `cmd.exe` to open the browser.
|
|
20
19
|
|
|
21
|
-
|
|
20
|
+
The agent's sandbox must permit spawning the browser opener and making localhost HTTP
|
|
21
|
+
requests. If either action is blocked, request approval/escalation with a short
|
|
22
|
+
justification rather than treating the denial as a bug with the document or the pageproof command.
|
|
23
|
+
|
|
24
|
+
The `pageproof` command will also print a status URL and a PID. Do not report these
|
|
25
|
+
to the user, unless the user explicitly asks for them. They are intended for you to
|
|
26
|
+
monitor the status of the document and the previewer so that you can help the user,
|
|
27
|
+
they are not useful for the user directly.
|
|
28
|
+
|
|
29
|
+
The server should automatically shut down when the user closes the browser tab.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
## Inspecting the status of the previewer
|
|
33
|
+
|
|
34
|
+
If the user asks about errors in the document, fetch the printed status URL:
|
|
22
35
|
```sh
|
|
23
36
|
curl http://localhost:<port>/status.json
|
|
24
37
|
```
|
|
25
38
|
The status includes Pandoc warnings and errors for the current document.
|
|
26
39
|
|
|
40
|
+
To check on the health of the server, either monitor the server's PID (which is printed on startup), or fetch `/status.json` which reports whether a browser is currently attached.
|
|
41
|
+
|
|
42
|
+
To terminate the server, kill the PID that was printed at startup:
|
|
43
|
+
```sh
|
|
44
|
+
kill <PID>
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
|
|
27
48
|
## Styles
|
|
28
49
|
|
|
29
|
-
|
|
50
|
+
If the user asks for a different document style, for example double-spaced output,
|
|
51
|
+
terminate the server then restart it with the requested style, e.g.
|
|
30
52
|
```sh
|
|
31
53
|
pageproof --detached --style=doublespaced FILE.md
|
|
32
54
|
```
|
|
33
55
|
|
|
34
|
-
|
|
56
|
+
To see a list available styles:
|
|
35
57
|
```sh
|
|
36
58
|
pageproof --styles
|
|
37
59
|
```
|
|
38
60
|
|
|
39
|
-
|
|
40
|
-
also options to specify the citation format. Use the CLI's `--citations` option
|
|
61
|
+
This command also shows options to specify the citation format. Use the CLI's `--citations` option
|
|
41
62
|
when the user asks for a specific citation style.
|
|
42
63
|
|
|
43
|
-
## Permissions and lifecycle
|
|
44
|
-
|
|
45
|
-
`pageproof` launches a browser tab and binds an HTTP server on a random localhost
|
|
46
|
-
port. Under WSL the browser is opened via `cmd.exe`.
|
|
47
|
-
|
|
48
|
-
The sandbox must permit spawning the browser opener and making localhost HTTP
|
|
49
|
-
requests. If either action is blocked, request approval/escalation with a short
|
|
50
|
-
justification rather than treating the denial as a document or CLI bug.
|
|
51
|
-
|
|
52
|
-
The server should automatically shut down when the user closes the browser tab.
|
|
53
|
-
To check on the health of the server, either monitor the server's PID
|
|
54
|
-
(which is printed on startup), or fetch `/status.json` which reports whether
|
|
55
|
-
a browser is currently attached. To terminate the server, kill the printed PID:
|
|
56
|
-
```sh
|
|
57
|
-
kill <PID>
|
|
58
|
-
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pageproof",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "Live Pandoc Markdown preview with paginated browser output.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"author": "Damon Wischik <djw1005@cam.ac.uk>",
|
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
"bin/",
|
|
22
22
|
"src/",
|
|
23
23
|
"README.md",
|
|
24
|
+
"CHANGELOG.md",
|
|
24
25
|
"LICENSE",
|
|
25
26
|
"THIRD_PARTY_NOTICES.md"
|
|
26
27
|
],
|