pageproof 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+## 0.1.2 - 2026-05-16
+
+- Updated the bundled Codex/Claude `SKILL.md`.
+
+## 0.1.1 - 2026-05-16
+
+- Renamed the package and other pieces to `pageproof`.
+
+## 0.1.0 - 2026-05-16
+
+- Initial npm release.

package/README.md

@@ -1,6 +1,6 @@
-# mdpreview
+# Pageproof
 
-`mdpreview` opens a live, paginated browser preview for a Markdown document. It
+`pageproof` opens a live, paginated browser preview for a Markdown document. It
 uses Pandoc for Markdown and citeproc citations, then uses Paged.js
 in the browser to render paginated output including footnotes. (Pandoc must be installed.)
 
@@ -13,13 +13,13 @@ Markdown can include scripts, so only preview Markdown you trust!
 ## Installation and usage
 
 ```sh
-npm install -g mdpreview
+npm install -g pageproof
 
 # install as a skill for codex
-mkdir -p ~/.agents/skills/mdpreview && mdpreview --show-skill > ~/.agents/skills/mdpreview/SKILL.md
+mkdir -p ~/.agents/skills/pageproof && pageproof --show-skill > ~/.agents/skills/pageproof/SKILL.md
 
 # install as a skill for Claude Code
-mkdir -p ~/.claude/skills/mdpreview && mdpreview --show-skill > ~/.claude/skills/mdpreview/SKILL.md
+mkdir -p ~/.claude/skills/pageproof && pageproof --show-skill > ~/.claude/skills/pageproof/SKILL.md
 ```
 
 ## Usage
@@ -32,13 +32,13 @@ and it should know what to do.
 To use it at the command line,
 
 ```sh
-mdpreview FILE.md
-mdpreview --style=doublespaced --citations=chicago FILE.md
-mdpreview --styles
+pageproof FILE.md
+pageproof --style=doublespaced --citations=chicago FILE.md
+pageproof --styles
 ```
 
 It will start up a browser viewing the compiled document. When the user
-closes the browser, `mdpreview` will automatically shut down.
+closes the browser, `pageproof` will automatically shut down.
 
 
 ## Document and citation styles
@@ -49,7 +49,7 @@ The default base-style list consists of just one, `msword`.
 Other bundled mix-in styles include `doublespaced`, and `numbered` for numbered section headings.
 Thus, for example, to get double-spaced output, use
 ```sh
-mdpreview --style=doublespaced FILE.md
+pageproof --style=doublespaced FILE.md
 ```
 
 **Citations** are handled by Pandoc. Your markdown document should include front-matter such as
@@ -61,18 +61,18 @@ bibliography: myrefs.bib
 ```
 and then you can cite using `[@citeref]`. To choose the citation format, use e.g.
 ```sh
-mdpreview --citations=chicago FILE.md
+pageproof --citations=chicago FILE.md
 ```
-Available citation formats are listed by `mdpreview --styles`.
+Available citation formats are listed by `pageproof --styles`.
 
 ## Configuration
 
-Add CSS stylesheets or CSL bibliography styles to `~/.mdpreview/`. They will be included
-in the `mdpreview --styles` list, and you can select them with `--style` or `--citations`.
+Add CSS stylesheets or CSL bibliography styles to `~/.pageproof/`. They will be included
+in the `pageproof --styles` list, and you can select them with `--style` or `--citations`.
 In the case of name conflict, user-provided files take precedence over the built-in styles.
 
 To specify the default document styles and citation style, specify the configuration
-in `~/.mdpreview/config.yaml`:
+in `~/.pageproof/config.yaml`:
 ```yaml
 styles: [msword]
 citations: european-journal-of-international-law

package/assets/SKILL.md

@@ -1,58 +1,63 @@
 ---
-name: mdpreview
+name: pageproof
 description: Use to open a live browser preview of a Markdown document, especially when the user wants to see it paginated and with citations and footnotes. Do not use for one-off Markdown-to-PDF conversion.
 ---
 
-# mdpreview
+# Pageproof
 
-`mdpreview` is a CLI tool that opens a live, paginated browser preview of a Markdown
+`pageproof` is a CLI tool that opens a live, paginated browser preview of a Markdown
 file. It handles footnotes and citations, and reloads automatically when the source file changes.
 
 ## Opening a preview
 
-Use this skill when the user asks to preview a Markdown document.
-Always invoke in detached mode so the shell returns once the preview is up:
+When the user asks to preview a Markdown document, invoke this comment:
 ```sh
-mdpreview --detached "FILE.md"
+pageproof --detached "FILE.md"
 ```
-It will launch a browser tab and start an HTTP server 
-on a random localhost port. It will also print a status URL.
+It will start an HTTP server on a random localhost port, and open a browser tab.
+On WSL, it will use `cmd.exe` to open the browser.
 
-If the user asks about errors in the document, fetch this printed status URL:
+The agent's sandbox must permit spawning the browser opener and making localhost HTTP
+requests. If either action is blocked, request approval/escalation with a short
+justification rather than treating the denial as a bug with the document or the pageproof command.
+
+The `pageproof` command will also print a status URL and a PID. Do not report these
+to the user, unless the user explicitly asks for them. They are intended for you to
+monitor the status of the document and the previewer so that you can help the user,
+they are not useful for the user directly.
+
+The server should automatically shut down when the user closes the browser tab.
+
+
+## Inspecting the status of the previewer
+
+If the user asks about errors in the document, fetch the printed status URL:
 ```sh
 curl http://localhost:<port>/status.json
 ```
 The status includes Pandoc warnings and errors for the current document.
 
+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.
+
+To terminate the server, kill the PID that was printed at startup:
+```sh
+kill <PID>
+```
+
+
 ## Styles
 
-To choose a different document style, for example double-spaced output:
+If the user asks for a different document style, for example double-spaced output,
+terminate the server then restart it with the requested style, e.g.
 ```sh
-mdpreview --detached --style=doublespaced FILE.md
+pageproof --detached --style=doublespaced FILE.md
 ```
 
-Use this to list available styles:
+To see a list available styles:
 ```sh
-mdpreview --styles
+pageproof --styles
 ```
 
-There are
-also options to specify the citation format. Use the CLI's `--citations` option
+This command also shows options to specify the citation format. Use the CLI's `--citations` option
 when the user asks for a specific citation style.
 
-## Permissions and lifecycle
-
-`mdpreview` launches a browser tab and binds an HTTP server on a random localhost
-port. Under WSL the browser is opened via `cmd.exe`. 
-
-The sandbox must permit spawning the browser opener and making localhost HTTP
-requests. If either action is blocked, request approval/escalation with a short
-justification rather than treating the denial as a document or CLI bug.
-
-The server should automatically shut down when the user closes the browser tab.
-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. To terminate the server, kill the printed PID:
-```sh
-kill <PID>
-```

package/assets/_paged.css

@@ -1,4 +1,4 @@
-/* mdpreview-style: Page geometry, Paged.js support, footnote mechanics, and preview chrome. */
+/* pageproof-style: Page geometry, Paged.js support, footnote mechanics, and preview chrome. */
 :root {
   color: black;
   background: #F0F0F0;

package/assets/doublespaced.css

@@ -1,4 +1,4 @@
-/* mdpreview-style: Double-spaced text override for manuscript drafts. */
+/* pageproof-style: Double-spaced text override for manuscript drafts. */
 html {
   line-height: 2;
 }

package/assets/favicon.svg

@@ -1,4 +1,4 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="mdpreview">
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64 64" role="img" aria-label="Pageproof">
   <rect width="64" height="64" rx="10" fill="#3f3f3f"/>
   <rect x="18" y="-10" width="28" height="34" rx="2" fill="#f7f7f2"/>
   <rect x="18" y="40" width="28" height="34" rx="2" fill="#f7f7f2"/>

package/assets/latex.css

@@ -1,4 +1,4 @@
-/* mdpreview-style: LaTeX-like document theme with Computer Modern-style typography. */
+/* pageproof-style: LaTeX-like document theme with Computer Modern-style typography. */
 :root {
   color: black;
   font-family: "MJX-TEX-N", "MJXTEX", "CMU Serif", "Computer Modern Serif",

package/assets/msword.css

@@ -1,4 +1,4 @@
-/* mdpreview-style: Default Times/Calibri document theme for academic prose. */
+/* pageproof-style: Default Times/Calibri document theme for academic prose. */
 :root {
   color: black;
   font-family: "Times New Roman", Times, serif;

package/assets/numbered.css

@@ -1,4 +1,4 @@
-/* mdpreview-style: Heading-numbering mix-in using legal-style nested counters. */
+/* pageproof-style: Heading-numbering mix-in using legal-style nested counters. */
 
 /* Unnumbered headings (Pandoc `# heading {-}`) are treated transparently to
    the counter cascade (matching LaTeX section-star): they do not advance the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pageproof",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Live Pandoc Markdown preview with paginated browser output.",
   "type": "module",
   "author": "Damon Wischik <djw1005@cam.ac.uk>",
@@ -21,6 +21,7 @@
     "bin/",
     "src/",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE",
     "THIRD_PARTY_NOTICES.md"
   ],

package/src/assets.js

@@ -30,7 +30,7 @@ export async function resolveAsset(kind, name, options = {}) {
   const filename = `${name}.${selector.ext}`;
   const homeDir = options.homeDir ?? os.homedir();
   const candidates = [
-    path.join(homeDir, '.mdpreview', filename),
+    path.join(homeDir, '.pageproof', filename),
     path.join(packageRoot, 'assets', filename)
   ];
 
@@ -70,12 +70,12 @@ export async function resolveAssets(selections, options = {}) {
 }
 
 async function loadConfig(homeDir) {
-  const configPath = path.join(homeDir, '.mdpreview', 'config.yaml');
+  const configPath = path.join(homeDir, '.pageproof', 'config.yaml');
   if (!(await pathExists(configPath))) return { path: configPath, data: {} };
   try {
     return { path: configPath, data: parseYaml(await fs.readFile(configPath, 'utf8')) ?? {} };
   } catch (error) {
-    throw new Error(`Invalid mdpreview config ${configPath}: ${error?.message || String(error)}`);
+    throw new Error(`Invalid pageproof config ${configPath}: ${error?.message || String(error)}`);
   }
 }
 
@@ -83,7 +83,7 @@ function configBaseStyles(config) {
   const base = config.data?.styles;
   if (base === undefined) return [...defaultBaseStyles];
   if (!Array.isArray(base) || base.some((item) => typeof item !== 'string')) {
-    throw new Error(`Invalid mdpreview config ${config.path}: styles must be a list of style names.`);
+    throw new Error(`Invalid pageproof config ${config.path}: styles must be a list of style names.`);
   }
   return base;
 }
@@ -92,7 +92,7 @@ function configCitationStyle(config) {
   const value = config.data?.citations;
   if (value === undefined) return null;
   if (typeof value !== 'string') {
-    throw new Error(`Invalid mdpreview config ${config.path}: citations must be a string.`);
+    throw new Error(`Invalid pageproof config ${config.path}: citations must be a string.`);
   }
   return value;
 }
@@ -119,7 +119,7 @@ async function listAvailableAssets(kind, homeDir) {
   if (!selector) throw new Error(`Unknown asset type: ${kind}`);
   const discovered = new Map();
   const roots = [
-    { source: 'user', dir: path.join(homeDir, '.mdpreview') },
+    { source: 'user', dir: path.join(homeDir, '.pageproof') },
     { source: 'bundled', dir: path.join(packageRoot, 'assets') }
   ];
 
@@ -164,7 +164,7 @@ async function describeAsset(kind, assetPath) {
 }
 
 function cssDescription(text) {
-  const match = text.match(/^\s*\/\*\s*mdpreview-style:\s*([^*]+?)\s*\*\//i);
+  const match = text.match(/^\s*\/\*\s*pageproof-style:\s*([^*]+?)\s*\*\//i);
   return match ? collapseWhitespace(match[1]) : '';
 }
 

package/src/cli.js

@@ -142,8 +142,8 @@ export async function stylesText(options = {}) {
 }
 
 function configHelpText() {
-  return `Additional styles (NAME.css) and citation styles (NAME.csl) can be placed in ~/.mdpreview/.
-Defaults can be overridden in ~/.mdpreview/config.yaml, e.g.
+  return `Additional styles (NAME.css) and citation styles (NAME.csl) can be placed in ~/.pageproof/.
+Defaults can be overridden in ~/.pageproof/config.yaml, e.g.
   styles: [msword]
   citations: european-journal-of-international-law`;
 }

package/bin/mdpreview.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-
-import { runCli } from '../src/cli.js';
-
-runCli(process.argv.slice(2)).catch((error) => {
-  console.error(error?.message || String(error));
-  process.exitCode = 1;
-});