TinyJS manual

Documentation

Everything you need to build, render, and ship a TinyJS site—from the first YAML file to the final HTML response.

01

Install the package

npm install @carl.fyi/tinyjs

02

Start the server

npx tinyjs serve

Full quickstart

Start here

Getting started

Install TinyJS, create the required files, and run your first local site.02

Project anatomy

File conventions

Learn the directory rules that define routes, navigation, configuration, and assets.03

Content model

Content & routing

Use structured YAML or JSON and predictable file-based URLs.04

Presentation

Templates & layouts

Compose server-side TSX templates through a structurally nested layout tree.05

Developer experience

TypeScript

Type site data, page data, HTML, SVG, accessibility attributes, and custom elements.06

Output

Rendering

Use one renderer for static builds and request-time server rendering.07

Deployment

Hosting on Vercel

Build the site as static HTML and deploy the generated output with Git or the Vercel CLI.08

Reference

API & CLI

See the programmatic render contract, command syntax, and generated metadata.09

Safety

Security & Markdown

Understand escaping, rejected scripting surfaces, raw HTML, and safe Markdown.10

Under the hood

Dependencies

TinyJS uses two runtime packages and the Node standard library.11

Complete site

Example project

Clone a standalone TinyJS site and inspect every convention working together.