mikser-io 6.21.2 → 6.21.3

package/README.md

@@ -2,23 +2,43 @@
   <img src="mikser-lockup-stacked.svg" alt="mikser" width="198" />
 </p>
 
-# Mikser Documentation
+# Mikser
 
-Mikser is a precision content engine for Node.js — built around a strict lifecycle, a composable plugin system, and zero compromise on output control. Every document, asset, and template flows through the same deterministic pipeline. Plugins hook in at any phase; nothing runs outside the cycle. The result is a system that scales from a single markdown blog to a multi-language, multi-format publishing platform — without ever losing sight of what it produced and why.
+Mikser is a content engine for Node.js built around a strict lifecycle, a composable plugin system, and direct control over every output. Every document, asset, and template flows through the same deterministic pipeline. Plugins hook in at any phase; nothing runs outside the cycle. It scales from a single markdown blog to a multi-language, multi-format publishing platform — and stays predictable in both directions.
 
-## Documentation Index
+## Why mikser
 
-| Document                                              | Audience           | Description                                        |
-| ----------------------------------------------------- | ------------------ | -------------------------------------------------- |
-| [Getting Started](./documentation/getting-started.md) | Users              | Installation, first project, basic usage           |
-| [Configuration](./documentation/configuration.md)     | Users              | All CLI options and config file reference          |
-| [Lifecycle](./documentation/lifecycle.md)             | Users & Developers | Complete lifecycle phases and hook system          |
-| [Plugins](./documentation/plugins.md)                 | Users & Developers | Built-in plugins, writing custom plugins           |
-| [Entities](./documentation/entities.md)               | Users & Developers | Entity model, operations, journal, catalog         |
-| [Rendering](./documentation/rendering.md)             | Users & Developers | Render pipeline, render plugins, render modes      |
-| [Watch Mode](./documentation/watch-mode.md)           | Users              | File watching, scheduled tasks, incremental builds |
-| [Architecture](./documentation/architecture.md)       | Developers         | System design, module structure, extension points  |
-| [API Reference](./documentation/api-reference.md)     | Developers         | Complete public API reference                      |
+**Your content stays yours.** Source files live on disk as `.md`, `.yml`, `.html` with YAML front-matter. The build output is plain static files. No database lock-in, no proprietary export format. The whole content tree is copyable, diffable, and version-controllable with git — your site is portable on day one and on year ten.
+
+**Incremental builds that scale.** Mikser tracks every entity in a journal. When a file changes, only the affected entities re-process — not the whole site graph. On 10k+ documents this dramatically outpaces tools that rebuild more on every change.
+
+**Concurrent rendering.** Renders fan out across a worker pool that keeps every CPU core hot. Multi-format outputs (HTML, PDF, MJML email, etc.) generate in parallel from the same source.
+
+**One lifecycle, everything composes.** Plugins hook into 20+ named lifecycle phases. A search-indexing plugin shares the same journal iteration as a CMS plugin and an email-rendering plugin — no glue code, no orchestration layer.
+
+**Run anywhere.** The same CLI handles one-shot builds, watch-mode dev loops, and a long-running HTTP server with a shared Express app. `npx mikser` ships a static site; `mikser --watch` is the dev loop; `mikser --server` exposes a live admin/API.
+
+**Library mode.** Mikser is also a library. `useRenderer`, `useCollection`, `findSimilar`, and direct lifecycle hooks let you embed the engine inside an existing Node app instead of running it as a CLI.
+
+**Open source.** MIT-licensed, on GitHub, no telemetry, no auth wall, no SaaS dependency. What you see is what runs.
+
+## Plugin ecosystem
+
+Plugins are independent npm packages — install only what a project actually uses.
+
+| Plugin | What it does |
+|---|---|
+| `documents`, `files`, `resources`, `assets` | Content sources |
+| `layouts` | Layout resolution with auto-matching |
+| `render-hbs`, `render-eta`, `render-liquid`, `render-markdown` | Template engines |
+| `render-resource`, `render-asset`, `render-href` | Resource / asset / link rewriting at render time |
+| `post-pdf` | HTML → PDF via headless Chromium |
+| `post-mjml` | MJML email markup → inbox-safe HTML |
+| `data` | JSON snapshots of entities / context / catalog over HTTP |
+| `api` | REST endpoints — list / get / create / update / delete / render |
+| `vector` | OpenAI embeddings + semantic search (sqlite-vec or pgvector) |
+| `decap` | [Decap CMS](https://decapcms.org/) mounted in the same process |
+| `archive`, `mapper`, `live`, `aml` | Specialty integrations |
 
 ## Quick Start
 
@@ -37,7 +57,9 @@ export default {
 ```
 
 ```bash
-npx mikser
+npx mikser              # one-shot build
+npx mikser --watch      # incremental dev loop
+npx mikser --server     # build + serve at :3001
 ```
 
 ## Core Concepts
@@ -47,3 +69,21 @@ npx mikser
 - **Plugins** — Functionality is delivered via plugins. Built-in plugins handle common sources (documents, files, layouts, assets). Custom plugins can be added to any project.
 - **Runtime Singleton** — A plain module-level object holds all global state and coordinates the lifecycle. The ES module cache guarantees every importer gets the same instance.
 - **Watch Mode** — In watch mode, file changes trigger incremental re-processing without restarting.
+
+## Documentation Index
+
+| Document                                              | Audience           | Description                                        |
+| ----------------------------------------------------- | ------------------ | -------------------------------------------------- |
+| [Getting Started](./documentation/getting-started.md) | Users              | Installation, first project, basic usage           |
+| [Configuration](./documentation/configuration.md)     | Users              | All CLI options and config file reference          |
+| [Lifecycle](./documentation/lifecycle.md)             | Users & Developers | Complete lifecycle phases and hook system          |
+| [Plugins](./documentation/plugins.md)                 | Users & Developers | Built-in plugins, writing custom plugins           |
+| [Entities](./documentation/entities.md)               | Users & Developers | Entity model, operations, journal, catalog         |
+| [Rendering](./documentation/rendering.md)             | Users & Developers | Render pipeline, render plugins, render modes      |
+| [Watch Mode](./documentation/watch-mode.md)           | Users              | File watching, scheduled tasks, incremental builds |
+| [Architecture](./documentation/architecture.md)       | Developers         | System design, module structure, extension points  |
+| [API Reference](./documentation/api-reference.md)     | Developers         | Complete public API reference                      |
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "mikser-io",
-	"version": "6.21.2",
+	"version": "6.21.3",
 	"description": "<p align=\"center\">   <img src=\"mikser-lockup-stacked.svg\" alt=\"mikser\" width=\"198\" /> </p>",
 	"main": "index.js",
 	"scripts": {
-		"debug": "node --no-warnings app.js --debug --working-folder test/fixture",
+		"debug": "node --no-warnings app.js --debug --server --watch --working-folder test/fixture",
 		"test:unit": "node --test --test-reporter=spec 'test/unit/**/*.test.js'",
 		"test:smoke": "node --no-warnings app.js --working-folder test/fixture",
 		"test": "npm run test:unit && npm run test:smoke"
@@ -56,6 +56,7 @@
 	},
 	"devDependencies": {
 		"fluent-ffmpeg": "^2.1.3",
+		"mikser-io-decap": "file:../mikser-io-decap",
 		"mikser-io-post-mjml": "file:../mikser-io-post-mjml",
 		"mikser-io-render-eta": "file:../mikser-io-render-eta",
 		"mikser-io-render-liquid": "file:../mikser-io-render-liquid",

package/src/plugins/post/pdf.js

@@ -16,9 +16,16 @@ export async function setup({ config, logger }) {
     const { default: puppeteer } = await import('puppeteer').catch(() => {
         throw new Error('Puppeteer is required for the pdf postprocessor — run: npm install puppeteer')
     })
+    // --no-sandbox / --disable-setuid-sandbox are required on most
+    // headless Linux servers and Docker images where Chrome's sandbox
+    // can't be set up. Applied by default and merged (deduped) with any
+    // user-supplied launch.args so callers can add flags without losing
+    // these. To run WITH the sandbox, override launch.args explicitly.
+    const defaultArgs = ['--no-sandbox', '--disable-setuid-sandbox']
     browser = await puppeteer.launch({
         headless: true,
-        ...config?.launch
+        ...config?.launch,
+        args: [...new Set([...defaultArgs, ...(config?.launch?.args ?? [])])],
     })
     logger.debug('Puppeteer browser launched')
 }