@kobekeye/mdf 1.1.0 → 1.1.3

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to npm
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      contents: read
+      id-token: write 
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Publish package
+        run: npm publish --provenance --access public

package/README.md

@@ -18,6 +18,7 @@ Welcome to mdf! Please note that this project is currently in the MVP (Minimum V
 
 ## Installation
 ### Windows
+If one hasn't install nodejs, click [here](https://nodejs.org) to install. After installing nodejs, type
 ```bash
 npm install -g @kobekeye/mdf
 ```
@@ -40,12 +41,23 @@ npm install -g @kobekeye/mdf
 mdf input.md              # outputs input.pdf
 mdf input.md output.pdf   # custom output name
 ```
+To watch the output pdf file, use 
+```bash
+mdf input.md -w             # outputs input.pdf and watches for changes
+mdf input.md output.pdf -w  # custom output name and watches for changes
+```
 Or, if you want to try without installation, 
 ```bash
-npx @kobekeye/mdf input.md              # outputs input.pdf
-npx @kobekeye/mdf input.md output.pdf   # custom output name
+npx @kobekeye/mdf input.md               # outputs input.pdf
+npx @kobekeye/mdf input.md output.pdf    # custom output name
+npx @kobekeye/mdf input.md -w            # outputs input.pdf and watches for changes
+npx @kobekeye/mdf input.md output.pdf -w # custom output name and watches for changes
 ```
-
+## Update
+```bash
+npm update -g @kobekeye/mdf
+```
+If you only use `npx` to run mdf, you don't need to update.
 ## Syntax Guide
 
 ### Table of Contents

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@kobekeye/mdf",
-  "version": "1.1.0",
+  "version": "1.1.3",
   "description": "Convert Markdown to beautiful PDFs — free, open-source, and zero-config.",
-  "main": "index.js",
+  "main": "src/cli.js",
   "bin": {
-    "mdf": "index.js"
+    "mdf": "src/cli.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"

package/{renderer.js → src/renderer.js}

@@ -149,9 +149,10 @@ function processTOC(html) {
     return html.replace(TOC_MARKER, toc);
 }
 // CSS file paths
-const themePath = path.join(__dirname, 'themes', 'default.css');
-const hljsCssPath = path.join(__dirname, 'node_modules', 'highlight.js', 'styles', 'github-dark.css');
-const texmathCssPath = path.join(__dirname, 'node_modules', 'markdown-it-texmath', 'css', 'texmath.css');
+const root = path.join(__dirname, '..');
+const themePath = path.join(root, 'themes', 'default.css');
+const hljsCssPath = path.join(root, 'node_modules', 'highlight.js', 'styles', 'github-dark.css');
+const texmathCssPath = path.join(root, 'node_modules', 'markdown-it-texmath', 'css', 'texmath.css');
 // KaTeX CSS is referenced as a local file:// URL so its bundled fonts resolve correctly
 const katexCssUrl = `file://${path.join(__dirname, 'node_modules', 'katex', 'dist', 'katex.min.css')}`;
 // CSS cache: read once, avoid I/O on every render