ak-render
/ak-render
Zamienia plan, raport, przegląd zmian lub dashboard w estetyczną stronę HTML offline, kompilując krótką specyfikację YAML poleceniem ak-render zamiast pisać HTML ręcznie.
- Autor
- bestagentkits ↗
- Repozytorium
- ak-render ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 19.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 1
Brak sygnałów. Repozytorium zmienione 19.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Zamienia plan, raport, przegląd zmian lub dashboard w estetyczną stronę HTML offline, kompilując krótką specyfikację YAML poleceniem ak-render zamiast pisać HTML ręcznie.
Oryginalny opis (EN)
Show a plan, report, recap, diff review, dashboard, explainer, or comparison as one polished offline HTML page. Write a short YAML Page Spec and compile it with the ak-render CLI (npm package @bestagentkits/render) instead of hand-writing HTML, CSS, or JavaScript. Use when the user asks for an HTML report, a visual or shareable page, a status update, a code-review summary, a KPI dashboard, a timeline, a checklist, or a risk review, or when a long result reads better as a page than as terminal text.
Jak działa
- Run the CLI
- The loop
- Minimal spec
- Pick blocks by intent
- Themes
- Rules
- MCP alternative
Podgląd SKILL.md
---
name: ak-render
description: Show a plan, report, recap, diff review, dashboard, explainer, or comparison as one polished offline HTML page. Write a short YAML Page Spec and compile it with the ak-render CLI (npm package @bestagentkits/render) instead of hand-writing HTML, CSS, or JavaScript. Use when the user asks for an HTML report, a visual or shareable page, a status update, a code-review summary, a KPI dashboard, a timeline, a checklist, or a risk review, or when a long result reads better as a page than as terminal text.
---
# AK Render
AK Render compiles a short YAML or JSON **Page Spec** into one deterministic,
self-contained HTML file. The page opens from `file://` and makes no network
request. You describe what the page says. The compiler owns layout, colour,
typography, motion, accessibility, and security.
## Run the CLI
Use `ak-render` if it is on `PATH`. Otherwise prefix every command with
`npx -y @bestagentkits/render`. Node.js 20.11 or later is required. Reading the
spec from stdin (`-`) and the `mcp` command need version 0.2.0 or later, and
`search-catalog`, `describe --compact`, `catalog --category` and recipes need
0.3.0 or later, so check `npx -y @bestagentkits/render --version` first. Every command accepts
`--json` and never prompts.
## The loop
**Shortcut for known page kinds.** When the page matches an intent (list them
with `npx -y @bestagentkits/render compose intents --json`, e.g.
`investment-report`), write only the typed content and compose it in one call;
keep the emitted spec for later edits. See [compose](https://github.com/bestagentkits/ak-render/blob/main/docs/compose.md).
```bash
npx -y @bestagentkits/render compose input.yaml --out page.html --spec-out page.yaml
```
Otherwise, or to change the page further, use the full loop:
1. **Find the blocks.** Search by intent, or list one category. The full
catalog of 90 block types and every action is about 8 kB:
```bash
npx -y @bestagentkits/render search-catalog sortable table
npx -y @bestagentkits/render catalog --category data
npx -y @bestagentkits/render catalog
```
2. **Describe only the blocks you use.** `--compact` gives one line per prop
for up to 12 types. Use `--json` on one type for its full contract:
```bash
npx -y @bestagentkits/render describe steps data-table chart --compact
npx -y @bestagentkits/render describe steps --json
```
3. **Write the spec** to a `.yaml` file, or pipe it on stdin with `-`. For a
common page, start from a recipe and replace every placeholder:
```bash
npx -y @bestagentkits/render recipes
npx -y @bestagentkits/render recipe incident-report > page.yaml
```
4. **Validate and fix.** Exit code 1 means fix and retry:
```bash
npx -y @bestagentkits/render validate page.yaml --json
cat page.yaml | npx -y @bestagentkits/render validate - --json
```
The result is `{ ok, diagnostics[] }`. Each diagnostic has a stable `code`
and a JSON `path` to fix, such as `$.blocks[0].titl`. For an unknown prop,
`details.allowed` lists the valid props. Fix every diagnostic by its path,
then validate again. `validate --suggest` adds `fixes` (JSON Patches marked
`safe` or `ambiguous`), and `repair page.yaml --out page.yaml` applies only
the safe ones; pick ambiguous ones yourself.
5. **Compile** to an `.html` file. The first argument is the spec path, or
`-` for stdin. `--theme` overrides the spec's preset:
```bash
npx -y @bestagentkits/render page.yaml --out page.html --json
npx -y @bestagentkits/render - --out page.html --theme swiss-clean < page.yaml
```
The JSON summary reports `out`, `bytes`, `hash`, `theme`, `features`, and
`warnings`. Don't read the HTML back into context, because the summary is
enough.
6. **Open it once.** Before you compile, check whether the `--out` file
exists. If it does not, open the new page with the platform opener:
`open page.html` on macOS, `xdg-open page.html` on Linux, or
`start page.html` on Windows. Then tell the user the path. If it exists,
don't open it again, because the user probably has it open already and
every opener call adds one more tab. Tell the user to refresh the page to
see the update.
7. **Edit with a patch, not a rewrite.** For a change to an existing spec,
send RFC 6902 ops; `/blocks/@<id>` addresses the block with that `id` at
any depth, so give blocks you will edit an `id`. The file keeps its
comments, the reply is a hash and the changes, never the spec, and a patch
that raises the error count is not written (check `written`; exit 1 still
means errors remain). Pass the previous reply's `hash` as
`--base-hash` so a stale edit is refused. Needs a release newer than 0.3.0
(`ak-render patch --help` prints its usage when it exists):
```bash
npx -y @bestagentkits/render patch page.yaml '[{"op":"replace","path":"/blocks/@revenue/title","value":"Revenue, FY26"}]' --json
```
Then compile again.
## Minimal spec
```yaml
version: 1
meta:
title: Migration plan
description: How we move the API to the new gateway.
theme:
preset: editorial # optional; see `themes`
blocks:
- type: hero
eyebrow: Plan
title: Migration plan
description: Move the public API to the new gateway without downtime.
- type: section
title: Steps
blocks:
- type: steps
items:
- title: Mirror traffic
text: Send a copy of production requests to the new gateway.
- title: Switch reads
text: Route read endpoints once error rates match.
- type: callout
tone: info
title: Rollback
text: Point DNS back to the old gateway; no data migrates.
```
## Pick blocks by intent
Prefer semantic blocks, because they carry the design for you. Confirm each
block with `describe` before you use it.
| Page | Start with |
| --- | --- |
| Plan or roadmap | `hero`, `steps`, `timeline`, `risk-matrix`, `checklist`, `callout`, `decision`, `feedback` |
| Recap or status | `hero`, `stats`, `timeline`, `checklist`, `list` |
| Diff or code review | `diff-summary`, `code-review`, `file-tree`, `code` |
| Dashboard | `kpi`, `chart`, `data-table`, `filter-bar`, `grid-item`, `main-aside` |
| Benchmark or evidence report | `benchmark-comparison`, `metric-breakdown`, `chart`, `references` |
| Incident or engineering status | `timeline`, `log-viewer`, `test-results`, `api-endpoint`, `kanban`, `roadmap` |
| Product page | `hero`, `pricing`, `feature-matrix`, `testimonial`, `logo-cloud`, `people` |
| Explainer | `hero`, `card-grid`, `tabs`, `accordion`, `code`, `callout` |
| Comparison or decision | `comparison`, `table`, `before-after`, `callout` |
For a plan the user must approve, put each open question in a `decision` and
mark the option you would pick `recommended`. End the page with one `feedback`
block: the user comments on any text, answers the decisions, and copies it all
back to you as one prompt. Act on that prompt before you build.
Group blocks with `section`. Tabs, accordion sections, carousel slides, and
bento tiles can hold blocks in `items[i].blocks`. Use `grid`, `split`, and
`stack` only when the semantic blocks can't express the structure.
Put numbers that several blocks show in top-level `datasets` and bind each
block with `dataRef`. Native controls write page `state`, and `visibleWhen`
switches views from it. `percent` takes `87` for "87%". Derive ratios,
deltas, percent changes and totals with `transform.derive` and
`transform.rollup` (data-table footer only) instead of computing them by hand, and give a `kpi` item a
`cite` (omit `value`) so its number comes from the same dataset.
## Themes
List the presets and set one with `theme.preset` in the spec or `--theme` on
the compile command:
```bash
npx -y @bestagentkits/render themes
```
The twelve built-in presets are `blueprint`, `crimson-press`, `data-console`,
`editorial`, `executive-report`, `newspaper`, `paper-ink`, `product-studio`,
`research-notebook`, `swiss-clean`, `terminal-mono`, and `warm-signal`, and `themes` also lists any
project or user presets it finds. Use only a name it lists. Don't try to restyle the page.
Motion is named, not authored. A block may opt into one recipe, such as
`motion: reveal-soft` on a card, `stagger` on steps, or `tabs-slide` on tabs;
`describe --compact` lists a type's recipes under `motion:`, `motions search
<intent>` ranks them, and `fade-swap` fits any block with `visibleWhen`.
`motion audit page.yaml` flags nested, excessive or never-playing motion, and
`motion studio page.yaml` lets a person tune it locally and accept a diff. Leave `motion` out unless motion helps the
reader; the compiler handles reduced motion and print.
Before handing a page to someone, run `audit-ui page.yaml --json` (add
`--preset publication` when a browser is available) and fix each finding at
its `path` with the `fix` it gives.
## Rules
- **No raw HTML, CSS, or JS.** The spec has no field for them, and keys such
as `rawHTML`, `iframe`, `srcdoc`, or `script` are rejected. Don't look for
an escape hatch, and don't post-process the emitted file. Links accept
`https`, `http`, `mailto`, and relative paths, and `javascript:` is rejected.
- **Backticks and double asterisks are the only inline markup.** In prose text
(a `text`, a step or list item's `text`, a `description`, a `caption`), a
pair of backticks renders as inline code, so write `` `ak-render validate` ``
for a command, path or URL, and `**key phrase**` renders as bold. Use bold
sparingly. Block titles, table cells and comparison items render the same
spans. `meta.title`, `code` blocks, and `terminal` lines stay literal.
- **Never invent data.** Every number, date, name, path, and finding must come
from the conversation, the repository, or tool output. If a value is
unknown, leave the block out or ask. Don't fill it with a plausible guess.
- **Keep the page offline.** `policy.network` defaults to `deny`, so a remote
image or video renders as a labelled fallback, and a remote video `poster`
fails validation. Opt in only when the user asks for remote media:
```yaml
policy:
network:
allow:
- images
```
## MCP alternative
`npx -y @bestagentkits/render mcp` serves the same loop over stdio as the tools
`catalog` (optional `category`), `search-catalog` (`query`), `describe`
(`type`, or `types` with optional `compact`), `search-icons` (`query`), `describe-icon`, `icon-packs`, `motions` (optional `query`, or `id` with `compact`), `recipes`, `recipe` (`name`),
`validate` (`spec`, optional `suggest`), `repair` (`spec`), `patch` (`ops` with `file` or `spec`, optional `baseHash`), `audit-motion` (`spec` or `html`), `audit-ui` (`spec` or `html`, optional `preset`), `compose` (`intent`, `content`, optional `theme`, `out`, `dryRun`, `returnSpec`), `render` (`spec`, `out`, optional `theme`), and `themes`. `spec` may be YAML or JSON text, or the parsed
object. `render` writes the file to `out` and returns only the summary. When
these tools are available, use them instead of the shell commands.
```json
{
"mcpServers": {
"ak-render": { "command": "npx", "args": ["-y", "@bestagentkits/render", "mcp"] }
}
}
```
Wersje
| Repozytorium | Wynik | Licencja |
|---|---|---|
| Ta strona · bestagentkits/ak-render | 100 | MIT |
| bestagentkits/ak-render | 100 | MIT |
Migawka bazy z 13.11.2026 · wersja paczki cace8ba194ea (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 100render
Zamienia plan, PRD, przegląd, audyt, porównanie, wyjaśnienie, mapę architektury lub raport statusu w interaktywną stronę HTML z komentarzami przy każdej sekcji, a potem odczytuje uwagi i działa na ich podstawie. - 100design-deck-render
Zamienia podany ustrukturyzowany tekst w jednoplikową prezentację HTML 1600x900 w ciemnym stylu archiwum, zamiast pliku PPTX. - 100pages
Decyduje, kiedy odpowiedź ma być stroną HTML lub Markdown zamiast wiadomości w czacie, i pisze oraz utrzymuje aktualną stronę. - 100v1-html-it
Tworzy samodzielną stronę HTML z raportem, pulpitem lub interaktywnym wyjaśnieniem, gotową do udostępnienia. - 100render-report
Zamienia raporty audytu UX na samodzielne strony HTML z kartami wyników, galerią zrzutów i pulpitem zbiorczym. - 100render-html
Zamienia artefakt Markdown lub JSON z ARIS na jeden plik HTML do czytania przez człowieka, z przejrzystym układem.