@miragon/create-slidev-deck 1.0.2 → 1.1.0

package/bin/index.mjs

@@ -143,19 +143,22 @@ function buildPackageJson(scratch, deckName, toolkitVersion) {
   const readManifest = (rel) => JSON.parse(readFileSync(join(scratch, rel), 'utf8'))
   const deckPkg = readManifest('deck/package.json')
   const rootPkg = readManifest('package.json')
+  const portlessVersion = deckPkg.devDependencies?.portless
+  if (!portlessVersion) throw new Error('Reference deck/package.json is missing devDependency portless')
   const pkg = {
     name: deckName,
     type: 'module',
     private: true,
     scripts: {
-      dev: 'slidev deck/slides.md --open',
+      dev: 'portless',
+      'dev:app': 'slidev deck/slides.md --port ${PORT:-3030} --remote --bind 127.0.0.1',
       build: 'slidev build deck/slides.md --out ../dist',
       export: 'slidev export deck/slides.md',
       verify: rootPkg.scripts.verify,
       'verify:source': rootPkg.scripts['verify:source'],
     },
     dependencies: { '@miragon/slidev-toolkit': toolkitVersion, ...deckPkg.dependencies },
-    devDependencies: verifyDevDeps(rootPkg),
+    devDependencies: { ...verifyDevDeps(rootPkg), portless: portlessVersion },
   }
   return JSON.stringify(pkg, null, 2) + '\n'
 }
@@ -200,6 +203,8 @@ async function layDownDeck({ scratch, target, deckName, toolkitVersion, ref, pre
 
     const packageJson = buildPackageJson(scratch, deckName, toolkitVersion)
     await writeFile(join(target, 'package.json'), packageJson)
+    const portlessJson = JSON.stringify({ name: deckName, script: 'dev:app' }, null, 2) + '\n'
+    await writeFile(join(target, 'portless.json'), portlessJson)
     await cp(join(HERE, '..', 'templates', 'README.md'), join(target, 'README.md'))
   } catch (err) {
     await rollback(target, preexisting)
@@ -215,7 +220,8 @@ Done. Your deck is ready in ${dir}
 Next steps:
   cd ${dir}
   ${pm} install
-  ${pm} run dev
+  npx portless service install   # one-time per machine: HTTPS proxy for the .localhost dev URL
+  ${pm} run dev                  # serves at https://${deckNameFrom(dir)}.localhost
 
 Build with '${pm} run build', check brand guardrails with '${pm} run verify'.`)
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@miragon/create-slidev-deck",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "type": "module",
   "description": "Scaffold a lean Miragon Slidev deck: only the files a deck needs, with @miragon/slidev-toolkit pulled from npm. Run via `npm create @miragon/slidev-deck`.",
   "keywords": [
@@ -31,7 +31,7 @@
     "giget": "3.3.0"
   },
   "devDependencies": {
-    "@miragon/slidev-toolkit": "1.4.0"
+    "@miragon/slidev-toolkit": "1.5.1"
   },
   "files": [
     "bin",

package/templates/README.md

@@ -7,13 +7,15 @@ npm package — you fill in the content, the theme is fixed.
 
 ## Quick start
 
-Needs **Node 20+** and a modern browser (WebGL2 for the animated background, with a CSS-gradient fallback).
+Needs **Node 20+** (**Node 24+** for `npm run dev`) and a modern browser (WebGL2 for the animated background, with a CSS-gradient fallback).
 
 ```bash
 npm install
-npm run dev      # opens the deck on http://localhost:3030 with live reload
+npm run dev      # serves the deck at https://<this-deck>.localhost with live reload
 ```
 
+`npm run dev` runs through [portless](https://portless.sh): a stable `.localhost` URL instead of a `:3030` port, so several decks run at once without colliding. The proxy auto-starts on first run (one-time `sudo`); `npx portless service install` makes it permanent. Use `npm run dev:app` to run the raw server without portless.
+
 Edit files under `deck/` and save — the preview updates instantly. Every demo slide carries a
 `REQUIRED / OPTIONAL / LIMIT / HOW TO USE` comment block: your in-place authoring guide.
 
@@ -32,7 +34,7 @@ The deck consumes the toolkit by name (`theme: '@miragon/slidev-toolkit'`); you
 
 | Command | Result |
 |---|---|
-| `npm run dev` | Live preview on `:3030`; `p` for presenter mode, `o` for overview |
+| `npm run dev` | Live preview at `https://<this-deck>.localhost` (portless); `p` for presenter mode, `o` for overview |
 | `npm run build` | Static `dist/` you can host anywhere |
 | `npm run export` | `slidev-exported.pdf` locally (needs Chromium) |
 | `npm run verify` | Full screenshot + checklist per slide against the design rules (local; needs a browser) |