Skip to main content
← back to extensions

Vados

@gklijs/vadosv2026.10.14.10· MIT· 1d agoBEHAVIORSACCEPTED WARNINGS
01README

Wraps the Vados static site generator CLI (vados check, generate, page, image, social, menu, footer, luma-event) for use in swamp workflows

02Behaviors1
@gklijs/vadosv2026.10.14.10vados.ts

Global Arguments

ArgumentTypeDescription
vadosBin?stringPath to the vados binary on the worker (defaults to 'vados' on PATH)
source?stringPath to the source tree directory (main.json, menu.json, page.json files)
imgSource?stringPath to the image source tree directory (images.json files)
destination?stringPath to the output directory (used by generate)
timeout?numberCommand execution timeout in milliseconds
fn check()
Run vados check — validate the source and image trees without writing anything
fn generate()
Run vados generate — publish a complete site from the source tree into the destination directory
fn page_new(path: string, title: string, content?: string, imageRef?: string, subTitle?: string, icon?: string, summary?: string, order?: number)
Create a new page.json for a path not yet in the source tree (with optional content and hero image)
ArgumentTypeDescription
pathstringURL path for the new page (e.g. '/blog/my-post')
titlestringPage title (rendered as the <h1> heading)
content?stringContent file path (.md/.html) or inline HTML for the page body
imageRef?stringExisting image reference (e.g. '/team/alice') to attach as the page hero image
subTitle?stringOptional page sub-title
icon?stringOptional page icon (Material Design Icons name)
summary?stringOptional page summary
order?numberOptional ordering hint among sibling pages
fn page_add_image(path: string, dir?: string, fileName?: string, existingReference?: string, as?: enum, altText?: string, caption?: string, side?: enum)
Attach an image to an existing page as its hero or as a notification — freshly registered or already declared
ArgumentTypeDescription
pathstringPage to attach the image to (e.g. '/blog/my-post')
dir?stringImage directory name, relative to the image source (omit for the image root)
fileName?stringImage file name to register as a new image (mutually exclusive with existingReference)
existingReference?stringAlready-declared image reference key (e.g. '/team/alice'), instead of registering a new one
as?enumOverride the automatic role choice: 'hero' or 'notification' (default: first attached image is hero)
altText?stringAlt text for a newly registered image (required with fileName; not accepted with existingReference)
caption?stringCaption shown for the attachment (notification images only)
side?enumWhich side a notification is added to (default: right)
fn image_add(dir?: string, fileName: string, altText: string, title?: string)
Register one image in an images.json, creating the file if the directory has none yet
ArgumentTypeDescription
dir?stringImage directory name to register under (e.g. 'team'; omit for the image root)
fileNamestringImage file name (e.g. 'alice.jpg')
altTextstringAlt text describing the image (required by vados check)
title?stringOptional human-readable image title
fn social_add()
Add a social link — use provider+handle for recognized providers (github, linkedin, facebook, youtube, twitter) or url for unrecognized ones
fn social_update(match: string, index?: number)
Replace an existing social link (matched by url substring) with a new provider+handle or url link
ArgumentTypeDescription
matchstringSubstring of the existing link's url to match
index?numberDisambiguate when more than one link matches (ranked among the matches)
fn social_remove(match: string, index?: number)
Remove an existing social link (matched by url substring)
ArgumentTypeDescription
matchstringSubstring of the existing link's url to match
index?numberDisambiguate when more than one link matches (ranked among the matches)
fn menu_add_item(url: string, title?: string, icon?: string)
Append one entry to the main menu (title required for external URLs)
ArgumentTypeDescription
urlstringMenu item URL (external 'https://...' requires title; internal '/path' uses the page's own title)
title?stringMenu item title (required for external URLs, optional for internal)
icon?stringOptional menu item icon (Material Design Icons name)
fn footer_set(content: string)
Replace the site-wide footer content reference
ArgumentTypeDescription
contentstringFooter content file path (e.g. 'footer.md') or inline HTML
fn page_luma_event(path: string, eventId: string, title: string, display?: enum, buttonLabel?: string)
Link a Luma event (eventId like 'evt-...') to a page, with display mode and button label
ArgumentTypeDescription
pathstringPage path to attach the Luma event to (e.g. '/events')
eventIdstringLuma event ID (must be of the form 'evt-...')
titlestringEvent title (shown as link text and accessible name)
display?enumHow to display the Luma event on the page
buttonLabel?stringText for the register button (defaults to 'Register')

Resources

result(4h)— Structured output from a vados CLI subcommand — exit code, stdout/stderr, duration, and success flag
03Previous Versions9
2026.10.14.9MIT
2026.10.14.8MIT
2026.10.14.7MIT
2026.10.14.6MIT
2026.10.14.5MIT
2026.10.14.4MIT
2026.10.14.3MIT
2026.10.14.2MIT
2026.10.14.1MIT
04Stats
A
100 / 100
Downloads
1
Archive size
12.8 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License2/2earned
  • Verified public repository2/2earned
Repository
https://github.com/gklijs/vados-swamp

06Platforms
07Labels
#vados#static-site#generator#bulma#rust#content-management