Getting Started with Typerighter
This guide walks you through setting up a Typerighter project from scratch: scaffold a project, set up your editor, write your first document, and deploy.
Scaffold a project
Run npx typerighter init in an empty directory. The CLI prompts for a project name, site title, and description, then writes the full project structure. No global install needed.
mkdir my-site && cd my-site
npx typerighter initThe result:
my-site/
typedown.yaml # site config
vault/
_types/
Article.td # article schema (title, description, tags)
Note.td # note schema (title, description, tags, author)
notes/
index.td # glossary index of all notes
getting-started.td # schemas, body interpolation, frefs
core-concepts.td # schema syntax, fref, vault query reference
index.td # home page with file structure and commands
components.td # built-in component demos
public/
favicon.svg
robots.txt
package.jsonSet up your editor
Before writing content, set up your editor so you get autocompletion, type checking, and diagnostics as you type. The setup-editor command detects installed editors and configures them for you:
npx typerighter setup-editorThis installs the LSP server and registers the .td file type for your editor. Neovim, VS Code, and Zed are supported. See Editor setup for manual instructions and editor-specific details.
Start the dev server
Install dependencies and start the dev server:
npm install
npm run devOpen http://localhost:8686. The site is live with a sidebar, search, and syntax highlighting.

Write your first document
Open vault/notes/getting-started.td in your editor. Every .td file has two parts: a YAML frontmatter block between --- markers that holds structured data, and a markdown body after it. The _type field connects the file to a schema - a template that declares which fields are allowed and what types they have. With the editor set up, you should see autocompletion and type checking as you edit.
---
_type: Note
title: "Getting started"
description: "A quick tour of typedown basics"
tags:
- "intro"
author: "You"
---
This file uses `_type: Note`, defined in `_types/Note.td`.
The `title`, `description`, `tags`, and `author` fields above are all type-checked.Open the page at http://localhost:8686/notes/getting-started to see the result:

Edit and see changes live
Try editing vault/notes/getting-started.td by adding a new section to the markdown body and saving:
## Why Typedown?
- **Typed content**: every field is validated against a schema
- **File references**: link documents together with `fref`
- **Live reload**: edits appear instantly in the browserThe browser will update instantly without a full reload.
Deploy
When you are ready to publish, build the site:
npm run buildThe output goes to dist/. It is a self-contained static site that needs no server. See Deploying for platform-specific instructions for GitHub Pages, Netlify, Vercel, and Cloudflare Pages.
What comes next
As your vault grows, Typedown's type system keeps it consistent. Schemas validate fields, file references (fref) link documents into a traversable graph, and vault queries let you compute relationships automatically - for example, finding all tasks assigned to a person without maintaining that list by hand:
---
_type: Person
name: "Alice"
assigned_tasks: vault.from_nodes(Task).filter((task) -> task.assignee == self)
---Explore these features in the guides:
Learn Typedown Syntax to understand vaults, schemas, expressions, and vault queries
CLI reference for all commands and options