miki-template 2.3.1 → 2.3.3

package/docs/guide/getting-started.md

@@ -1,204 +0,0 @@
-# Getting Started
-
-
-
-Get up and running with miki-template in under a minute.
-
-
-
-## Prerequisites
-
-
-
-- **Node.js** 18.x or 20.x (or later, including Bun)
-
-- **npm** 9+, **pnpm**, or **yarn**
-
-
-
-## Installation
-
-
-
-=== "npm"
-
-
-
-    ```bash
-
-    npm install miki-template
-
-    ```
-
-
-
-=== "pnpm"
-
-
-
-    ```bash
-
-    pnpm add miki-template
-
-    ```
-
-
-
-=== "yarn"
-
-
-
-    ```bash
-
-    yarn add miki-template
-
-    ```
-
-
-
-## Quick Example: Render a Template String
-
-
-
-The simplest way to use miki-template is the `render()` convenience function. It compiles the template, applies any registered context processors, and returns the HTML — all in one call.
-
-
-
-=== "CommonJS (require)"
-
-
-
-    ```javascript
-
-    const { render } = require('miki-template');
-
-
-
-    const html = render('Hello {{ name|title }}!', { name: 'alice' });
-
-    console.log(html); // "Hello Alice!"
-
-    ```
-
-
-
-=== "ES Modules (import)"
-
-
-
-    ```javascript
-
-    import { render } from 'miki-template';
-
-
-
-    const html = render('Hello {{ name|title }}!', { name: 'alice' });
-
-    console.log(html); // "Hello Alice!"
-
-    ```
-
-
-
-## Quick Example: Express App
-
-
-
-The real power of miki-template comes with `setupExpress()` — a single function that registers the view engine, configures the views directory, and patches `res.render` so you can render partials with the `view#partial` syntax.
-
-
-
-=== "CommonJS (require)"
-
-
-
-    ```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, () => console.log('Listening on :3000'));
-
-    ```
-
-
-
-=== "ES Modules (import)"
-
-
-
-    ```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, () => console.log('Listening on :3000'));
-
-    ```
-
-
-
-=== "Bun"
-
-
-
-    ```typescript
-
-    import { setupExpress } from 'miki-template';
-
-    import express from 'express';
-
-
-
-    const app = express();
-
-    // Named import works; default import also works (`import miki from ...`)
-
-    setupExpress(app, { extension: 'html', views: './views' });
-
-    ```
-
-
-
-## Next Steps
-
-
-
-- [What is miki-template?](./what-is-miki-template.md)
-
-- [Why miki-template?](./why-miki-template.md)
-
-- [Installation Guide](./installation.md)
-
-- [Quick Start](./quick-start.md)
-
-- [Template Syntax & Tags](./tags.md)
-
-- [Filters](./filters.md)
-

package/docs/guide/installation.md

@@ -1,190 +0,0 @@
-# Installation
-
-
-
-Complete guide to installing and verifying miki-template in different environments.
-
-
-
-## Requirements
-
-
-
-- **Node.js** 18.x or 20.x (Node 18+ required for `URL`, `fetch`, and other Web API globals used by the engine)
-
-- **npm** 9+, **pnpm**, or **yarn**
-
-- **Bun** (optional) — miki-template is fully compatible with Bun
-
-
-
-## Install via npm
-
-
-
-```bash
-
-npm install miki-template
-
-```
-
-
-
-## Install via pnpm
-
-
-
-```bash
-
-pnpm add miki-template
-
-```
-
-
-
-## Install via yarn
-
-
-
-```bash
-
-yarn add miki-template
-
-```
-
-
-
-## Install via Bun
-
-
-
-```bash
-
-bun add miki-template
-
-```
-
-
-
-## Package.json `"type"` Considerations
-
-
-
-miki-template ships a dual CommonJS/ESM package:
-
-
-
-- **CommonJS** entry: `src/index.js` — importable via `require('miki-template')` or `import` (Node auto-detects the `import` condition).
-
-- **ESM** entry: `src/esm.mjs` — importable via `import ... from 'miki-template'`.
-
-
-
-| Your project uses | How to import |
-
-|---|---|
-
-| CommonJS (`"type": "commonjs"` or no `type` field) | `const miki = require('miki-template')` |
-
-| ES Modules (`"type": "module"`) | `import miki from 'miki-template'` or `import { render } from 'miki-template'` |
-
-| TypeScript /Bun | Same as ESM — `import` syntax works directly |
-
-
-
-> **Tip:** If your project is ESM-only (no `"type"` field but using `.mjs` files), use named imports: `import { render, compile } from 'miki-template'`.
-
-
-
-## Verifying the Installation
-
-
-
-=== "CommonJS"
-
-
-
-    ```javascript
-
-    const miki = require('miki-template');
-
-    console.log(miki.render('Hello {{ name }}!', { name: 'World' }));
-
-    // Output: Hello World!
-
-    ```
-
-
-
-=== "ES Modules"
-
-
-
-    ```javascript
-
-    import { render } from 'miki-template';
-
-    console.log(render('Hello {{ name }}!', { name: 'World' }));
-
-    // Output: Hello World!
-
-    ```
-
-
-
-=== "Bun / TypeScript"
-
-
-
-    ```typescript
-
-    import { render } from 'miki-template';
-
-    console.log(render('Hello {{ name }}!', { name: 'World' }));
-
-    // Output: Hello World!
-
-    ```
-
-
-
-## Troubleshooting
-
-
-
-### "Cannot find module 'miki-template'"
-
-
-
-Ensure the package is installed in the correct `node_modules` directory. If you're working in a monorepo, run `npm install` from the package root.
-
-
-
-### Auto-escaping produces `&` where you expect `&`
-
-
-
-This is by design — miki-template escapes all variables by default to prevent XSS. Use `|safe` or `markSafe()` for trusted HTML:
-
-
-
-```html
-
-{{ htmlContent|safe }}
-
-```
-
-
-
-See [Security](./security.md) for details.
-
-
-
-## Next Steps
-
-
-
-- [Quick Start](./quick-start.md)
-
-- [What is miki-template?](./what-is-miki-template.md)
-