miki-template 2.2.3 → 2.3.0

package/docs/integrations/express.md

@@ -1,219 +1,219 @@
-# Express
-
-Express is the most common integration. Use `setupExpress()` for one-line setup.
-
-## Setup
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-## Options
-
-| Option | Default | Description |
-|--------|---------|-------------|
-| `extension` | `'html'` | File extension for views. Use `'miki'` if you prefer `.miki` files. |
-| `views` | `app.get('views')` | Views directory (passed to `app.set('views', ...)`). |
-| `async` | `false` | Use the async engine (`__expressAsync`). For Express 5+ with async helpers. |
-
-> The `res.render` shim intercepts **only** view names containing a `#`. Everything else (full pages, `res.render(view, cb)`, callback forms) goes through Express's normal view lookup, so the integration is fully compatible with existing Express middleware.
-
-## Manual Setup
-
-If you prefer full control:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const { __express } = require('miki-template');
-
-    const app = express();
-    app.engine('html', __express);
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import { __express } from 'miki-template';
-
-    const app = express();
-    app.engine('html', __express);
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-## Async Express 5+
-
-Express 5+ supports async route handlers natively. Pass `async: true` to `setupExpress`, or use `__expressAsync` directly:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
-
-    app.get('/user/:id', async (req, res) => {
-      const user = await User.findById(req.params.id);
-      if (!user) return res.status(404).send('Not found');
-      res.render('user-profile', { user });
-    });
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
-
-    app.get('/user/:id', async (req, res) => {
-      const user = await User.findById(req.params.id);
-      if (!user) return res.status(404).send('Not found');
-      res.render('user-profile', { user });
-    });
-    ```
-
-## Partial Renderer Middleware
-
-Add partial rendering without changing engine registration:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-    app.use(miki.expressPartialRenderer());
-
-    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-    // Note: must call expressPartialRenderer() before routes
-    app.use(miki.expressPartialRenderer());
-
-    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
-    ```
-
-## Express Adapter (app.engine)
-
-If you prefer not to use `setupExpress()`, you can use `express()` directly as a view engine:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const { express: mikiExpress } = require('miki-template');
-
-    const app = express();
-    app.engine('html', mikiExpress({ async: true }));
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import { express as mikiExpress } from 'miki-template';
-
-    const app = express();
-    app.engine('html', mikiExpress({ async: true }));
-    app.set('view engine', 'html');
-    app.set('views', './views');
-    ```
-
-## HTMX Example
-
-miki-template's partial rendering (`#partialName`) is purpose-built for HTMX and similar frameworks:
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    // Full page — initial load
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    // HTMX partial — only re-renders the "card" component
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.get('/partials/:name', (req, res) =>
-      res.render(`home#${req.params.name}`, { user: req.user })
-    );
-
-    app.listen(3000);
-    ```
-
-## Next Steps
-
-- [Integrations Overview](../)
-- [API Reference: setupExpress](../api/setup-express)
+# Express
+
+Express is the most common integration. Use `setupExpress()` for one-line setup.
+
+## Setup
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const miki = require('miki-template');
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+    app.get('/partials/:name', (req, res) =>
+      res.render(`home#${req.params.name}`, { user: req.user })
+    );
+
+    app.listen(3000);
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import miki from 'miki-template';
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+    app.get('/partials/:name', (req, res) =>
+      res.render(`home#${req.params.name}`, { user: req.user })
+    );
+
+    app.listen(3000);
+    ```
+
+## Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `extension` | `'html'` | File extension for views. Use `'miki'` if you prefer `.miki` files. |
+| `views` | `app.get('views')` | Views directory (passed to `app.set('views', ...)`). |
+| `async` | `false` | Use the async engine (`__expressAsync`). For Express 5+ with async helpers. |
+
+> The `res.render` shim intercepts **only** view names containing a `#`. Everything else (full pages, `res.render(view, cb)`, callback forms) goes through Express's normal view lookup, so the integration is fully compatible with existing Express middleware.
+
+## Manual Setup
+
+If you prefer full control:
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const { __express } = require('miki-template');
+
+    const app = express();
+    app.engine('html', __express);
+    app.set('view engine', 'html');
+    app.set('views', './views');
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import { __express } from 'miki-template';
+
+    const app = express();
+    app.engine('html', __express);
+    app.set('view engine', 'html');
+    app.set('views', './views');
+    ```
+
+## Async Express 5+
+
+Express 5+ supports async route handlers natively. Pass `async: true` to `setupExpress`, or use `__expressAsync` directly:
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const miki = require('miki-template');
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
+
+    app.get('/user/:id', async (req, res) => {
+      const user = await User.findById(req.params.id);
+      if (!user) return res.status(404).send('Not found');
+      res.render('user-profile', { user });
+    });
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import miki from 'miki-template';
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views', async: true });
+
+    app.get('/user/:id', async (req, res) => {
+      const user = await User.findById(req.params.id);
+      if (!user) return res.status(404).send('Not found');
+      res.render('user-profile', { user });
+    });
+    ```
+
+## Partial Renderer Middleware
+
+Add partial rendering without changing engine registration:
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const miki = require('miki-template');
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+    app.use(miki.expressPartialRenderer());
+
+    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import miki from 'miki-template';
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+    // Note: must call expressPartialRenderer() before routes
+    app.use(miki.expressPartialRenderer());
+
+    app.get('/card', (req, res) => res.renderPartial('home#card', { user: req.user }));
+    ```
+
+## Express Adapter (app.engine)
+
+If you prefer not to use `setupExpress()`, you can use `express()` directly as a view engine:
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const { express: mikiExpress } = require('miki-template');
+
+    const app = express();
+    app.engine('html', mikiExpress({ async: true }));
+    app.set('view engine', 'html');
+    app.set('views', './views');
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import { express as mikiExpress } from 'miki-template';
+
+    const app = express();
+    app.engine('html', mikiExpress({ async: true }));
+    app.set('view engine', 'html');
+    app.set('views', './views');
+    ```
+
+## HTMX Example
+
+miki-template's partial rendering (`#partialName`) is purpose-built for HTMX and similar frameworks:
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const miki = require('miki-template');
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    // Full page — initial load
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+
+    // HTMX partial — only re-renders the "card" component
+    app.get('/partials/:name', (req, res) =>
+      res.render(`home#${req.params.name}`, { user: req.user })
+    );
+
+    app.listen(3000);
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import miki from 'miki-template';
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+
+    app.get('/partials/:name', (req, res) =>
+      res.render(`home#${req.params.name}`, { user: req.user })
+    );
+
+    app.listen(3000);
+    ```
+
+## Next Steps
+
+- [Integrations Overview](../index.md)
+- [API Reference: setupExpress](../api/setup-express.md)

package/docs/integrations/fastify.md

@@ -73,5 +73,7 @@ Use miki-template with Fastify by calling `asyncRender()` inline in your route h
 
 ## Next Steps
 
-- [Integrations Overview](../)
-- [API Reference: asyncRender](../api/async-render)
+- [Integrations Overview](../index.md)
+- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
+, '../.md' -replace '([a-z][a-z0-9-]+)
+, '../.md' 

package/docs/integrations/hono.md

@@ -74,5 +74,7 @@ Use miki-template with Hono (ESM-first framework) by calling `asyncRender()` in
 
 ## Next Steps
 
-- [Integrations Overview](../)
-- [API Reference: asyncRender](../api/async-render)
+- [Integrations Overview](../index.md)
+- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
+, '../.md' -replace '([a-z][a-z0-9-]+)
+, '../.md' 

package/docs/integrations/index.md

@@ -1,68 +1,68 @@
-# Integrations Overview
-
-miki-template works with all major Node.js web frameworks. Use `render()` for synchronous output or `asyncRender()` for templates with async filters/tags.
-
-## Supported Frameworks
-
-- [Express](./express) — One-line setup with `setupExpress()`
-- [Koa](./koa) — Context helper using `asyncRender()`
-- [Fastify](./fastify) — Inline `asyncRender()` calls
-- [Hono](./hono) — ESM-first, using `asyncRender()`
-- [Elysia](./elysia) — ESM-first, using `asyncRender()`
-- [NestJS](./nestjs) — Module/Provider pattern
-- [TSDX / TS-Economy (TSed)](./tsed) — TypeScript integration
-
-## Quick Example
-
-=== "CommonJS"
-
-    ```javascript
-    const express = require('express');
-    const miki = require('miki-template');
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.listen(3000);
-    ```
-
-=== "ES Modules"
-
-    ```javascript
-    import express from 'express';
-    import miki from 'miki-template';
-
-    const app = express();
-    miki.setupExpress(app, { extension: 'html', views: './views' });
-
-    app.get('/', (req, res) => res.render('home', { user: req.user }));
-
-    app.listen(3000);
-    ```
-
-## Notes
-
-- For CommonJS: `const miki = require('miki-template');`
-- For ESM / Bun: `import miki from 'miki-template';` or `import * as miki from 'miki-template';`
-- When rendering files, pass `options.views` or set framework view roots so the engine can locate templates.
-- Use `asyncRender()` if your templates use async filters, async tags, or `{% load %}` libraries with async components.
-
-## Installation
-
-```bash
-# npm
-npm install miki-template
-
-# bun
-bun add miki-template
-
-# yarn
-yarn add miki-template
-```
-
-## Next Steps
-
-- [Express Integration](./express)
-- [API Reference: render](../api/render)
+# Integrations Overview
+
+miki-template works with all major Node.js web frameworks. Use `render()` for synchronous output or `asyncRender()` for templates with async filters/tags.
+
+## Supported Frameworks
+
+- [Express](./express.md) — One-line setup with `setupExpress()`
+- [Koa](./koa.md) — Context helper using `asyncRender()`
+- [Fastify](./fastify.md) — Inline `asyncRender()` calls
+- [Hono](./hono.md) — ESM-first, using `asyncRender()`
+- [Elysia](./elysia.md) — ESM-first, using `asyncRender()`
+- [NestJS](./nestjs.md) — Module/Provider pattern
+- [TSDX / TS-Economy (TSed)](./tsed.md) — TypeScript integration
+
+## Quick Example
+
+=== "CommonJS"
+
+    ```javascript
+    const express = require('express');
+    const miki = require('miki-template');
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+
+    app.listen(3000);
+    ```
+
+=== "ES Modules"
+
+    ```javascript
+    import express from 'express';
+    import miki from 'miki-template';
+
+    const app = express();
+    miki.setupExpress(app, { extension: 'html', views: './views' });
+
+    app.get('/', (req, res) => res.render('home', { user: req.user }));
+
+    app.listen(3000);
+    ```
+
+## Notes
+
+- For CommonJS: `const miki = require('miki-template');`
+- For ESM / Bun: `import miki from 'miki-template';` or `import * as miki from 'miki-template';`
+- When rendering files, pass `options.views` or set framework view roots so the engine can locate templates.
+- Use `asyncRender()` if your templates use async filters, async tags, or `{% load %}` libraries with async components.
+
+## Installation
+
+```bash
+# npm
+npm install miki-template
+
+# bun
+bun add miki-template
+
+# yarn
+yarn add miki-template
+```
+
+## Next Steps
+
+- [Express Integration](./express.md)
+- [API Reference: render](../api/render.md)

package/docs/integrations/koa.md

@@ -84,5 +84,7 @@ Use miki-template with Koa by attaching an async render helper to the context.
 
 ## Next Steps
 
-- [Integrations Overview](../)
-- [API Reference: asyncRender](../api/async-render)
+- [Integrations Overview](../index.md)
+- [API Reference: asyncRender param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
+, '../.md' -replace '([a-z][a-z0-9-]+)
+, '../.md' 

package/docs/integrations/nestjs.md

@@ -74,5 +74,7 @@ renderCard(@Req() req: Request, @Res() res: Response) {
 
 ## Next Steps
 
-- [Integrations Overview](../)
-- [API Reference: setupExpress](../api/setup-express)
+- [Integrations Overview](../index.md)
+- [API Reference: setupExpress param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
+, '../.md' -replace '([a-z][a-z0-9-]+)
+, '../.md' 

package/docs/integrations/tsed.md

@@ -77,5 +77,7 @@ renderCard(@Req() req: Request, @Res() res: Response) {
 
 ## Next Steps
 
-- [Integrations Overview](../)
-- [API Reference: setupExpress](../api/setup-express)
+- [Integrations Overview](../index.md)
+- [API Reference: setupExpress param($m) $m.Value -replace '([a-z][a-z0-9-]+)\.md
+, '../.md' -replace '([a-z][a-z0-9-]+)
+, '../.md'