maket_doc
Manage design document lifecycle: create, clone, rename, delete, list, update metadata, pin/unpin, export, and import .maket bundles.
Instructions
When to use: every persistent document-lifecycle operation — create, clone, rename, delete, list, update metadata, or move bundles in/out. For session-level actions (open a doc/page in the preview, inspect state, lock), use maket_workspace. For per-page edits use maket_page and for content use maket_html.
doc is the doc in scope for every action except list. name only appears when you need a NEW name (duplicate, rename).
Manage design documents (the workspace unit: canvas + pages + meta).
new — create a blank document at doc; sets it active. Previous unsaved work is lost.
list — enumerate saved documents: pinned documents first (most recently pinned first, marked 📌, with their category), then the other documents as a hierarchy of category paths.
lookup — read-only identity of doc by exact name, Workspace documents included: JSON {name, id, revision (monotonic modification token), pageCount, dataModel, stateRevision (null without state)}. It never opens the preview nor changes the active document. When absent, the error lists near matches.
link — return a reading path for doc, using its stable document id and configured browser base path. Prefix it with the reachable gateway origin.
delete — remove doc permanently; refused if it's the only document left.
duplicate — clone doc → name (format variants, A/B copies).
rename — rename doc → name.
meta — update doc's metadata: designNotes, teamNotes, rating, category, charte, responsive. The responsive flag applies to every browser-reader page while canvas/PDF keep authored dimensions. Owned Workspace templates accept responsive alone; sync_template propagates it.
pin — pin doc at the top of the document lists (desktop library, Reader navigation, list). The most recently pinned document comes first; pinning an already pinned doc keeps its place. Allowed on locked documents. Workspace item pins appear under their collection in the Workspace sidebar; indexes and templates cannot be pinned.
unpin — remove doc's pin; free documents return to their category and Workspace items disappear from the pinned shortcuts.
export — write a portable .maket bundle to EXPORTS_DIR. By default the bundle embeds referenced asset binaries (images, SVGs) so it survives transfer to another machine or a fresh datadir. Pass include_assets=false for a lighter structure-only snapshot. Include doc for a single document, docs for a list, or omit both to export every document. Referenced chartes, collections, and current document-state snapshots (with their revision retention) are embedded automatically; revision history stays local. Override the filename with output.
import — load a .maket bundle from input (absolute path or EXPORTS_DIR-relative). Documents land with conflict-renamed names; chartes and collections skip names that already exist. Current document-state snapshots initialize revision 1, and assets are restored to ASSETS_DIR with the existing collision rule.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| doc | No | The doc in scope. Required for every action except list. For lookup: the exact name to read. For new: the new doc's name (must be unique). For delete/meta/pin/unpin: the doc to act on. For duplicate/rename: the source doc. | |
| docs | No | For export: list of doc names to include in the bundle. Omit to export all documents. Ignored by other actions. | |
| name | No | The new name. Only used by duplicate (clone's name) and rename (new name). | |
| input | No | For import: absolute or EXPORTS_DIR-relative path to a .maket file to load. | |
| width | No | Width in millimetres for AUTO format; required on creation. Height follows each page content. | |
| action | Yes | Operation to run. See the tool description for the action table. | |
| charte | No | For new/meta: name of an existing charte to associate with this document. The charte itself is applied later via maket_charte view. | |
| format | No | For new: paper/screen format, or AUTO with width in mm and automatic page height. Default A3. Paper sizes are mm; DESKTOP/TABLET/MOBILE are screen aspect ratios scaled to mm. | |
| output | No | For export: output filename (defaults to <doc>.maket or maket-bundle.maket). Absolute paths are honoured; bare names land in EXPORTS_DIR. | |
| rating | No | For meta: 0–5 star rating (clamped). | |
| margins | No | For new: per-side safe-zone insets in mm {top, right, bottom, left}. Optional. | |
| category | No | For new/meta: category path separated by / (for example clients/acme). Flat values remain valid roots; default general. | |
| teamNotes | No | For meta: team-facing notes (visible in the UI). | |
| background | No | For new: canvas background colour (CSS). Default #ffffff. | |
| responsive | No | For new/meta: opt this entire document into fluid browser reading at its available pane width. Default false; canvas authoring and PDF keep their physical dimensions. On a Workspace template only this field may be changed through meta; then sync_template propagates it to projections. | |
| designNotes | No | For meta: designer-facing notes (visible in the UI). | |
| orientation | No | For new: page orientation. Default portrait. | |
| include_assets | No | For export: embed referenced asset binaries (images, SVGs) in the bundle. Default true — produces a portable .maket that survives transfer to another machine or datadir. Set false for a structure-only snapshot (smaller, git-friendly). |