Woozie

Woozie Documentation

Everything you need to know about building websites with Woozie, from first install to production deploy.

Woozie Documentation

This is the full reference for Woozie. Whether you've never touched a framework before or you just want to look up how a specific component works, this is the place.


Sections

Getting Started

New here? Start with these.

GuideWhat it covers
install.mdInstalling Woozie from npm
structure.mdWhat every file and folder does
first-page.mdBuilding your first page from scratch

Components

The full list of every built-in component, with examples you can copy.

GuideWhat it covers
layout.mdcol, row, grid, center, container, section, spacer, divider, wrap
typography.mdheading, text, link, bold, italic, code, quote, label
interactive.mdbutton, input, textarea, select, toggle, checkbox, radio, slider, dropdown
containers.mdcard, hero, nav, tabs, accordion, modal, header, footer
data-feedback.mdalert, badge, progress, spinner, stat, list, table, tooltip, image, video

Pages and Routing

GuideWhat it covers
routing.mdMulti-page sites, clean URLs, navigation, shared layouts

Styling

GuideWhat it covers
themes.mdstyle.woozie, woozie.rules, dark/light themes, fonts, CSS variables

Plugins

GuideWhat it covers
local-plugins.mdCreating and using local reusable plugins
comet-ui.mdInstalling, creating, and publishing CometUI community packages

Scripting

GuideWhat it covers
custom-js.mdAdding your own JavaScript to Woozie projects

Deployment

GuideWhat it covers
deploy.mdBuilding for production, deploying to Vercel, Netlify, GitHub Pages

Quick Start

npm install -g wozie
woozie init myapp
cd myapp
woozie run

Open http://localhost:3000 and you're good.


Cheat Sheet

// basics
heading "Title"
text "A paragraph."
button "Click" [variant=solid, color=primary]
link "Go" [page=about]
image "pic.jpg"

// layout
row:                         -- horizontal
column:                      -- vertical
grid [cols=3]:               -- responsive grid
card:                        -- styled card

// navigation
nav:
    navlink "Home" [page=index]
    navlink "About" [page=about]

// plugins (register in woozie.rules)
plugins:
    navbar = plugins/navbar.woozie

// then use it
@navbar

// community plugins
woozie add coolcards
comet:coolcards:pricing_card "Pro" [price=$29/mo]

// custom js
script "app-logic.js"