# Quickstart

https://vowel.cc/quickstart

From markdown to the web in moments.

```bash
# node@^26 npx vowel@latest
```

When you first run Vowel, a setup wizard will offer to help write your settings (`settings.md`) and homepage (`home.md`) files.

When your site is ready, Vowel will serve it on `http://localhost:8000`. It will watch your files and update the DOM as you make updates.

## Home

`home.md` is your homepage:

```markdown
# My Website Welcome to my world.
```

Your homepage title will serve as your website title, unless you override it in `settings.md`.

## Pages

(Almost) every markdown file is page. The URL is a simplified version of the file path.

You can define metadata in frontmatter:

```yaml
title: About description: This is the description.
```

And you can also write it in simple markdown:

```markdown
# About This is the description. --- This is the body content.
```

[More information on writing metadata.](https://vowel.cc/docs/guides/markdown#heading_metadata)

Vowel will infer a page's breadcrumb from its file name or the `breadcrumb` frontmatter property.

Pages will automatically go into navigation menus, listed by their breadcrumb.

## Posts

Vowel treats and file with a date as a post, which means it gets published in the RSS feed but it's omitted from navigation menus.

Set the date in the frontmatter `date` property or by writing the date above the content of the post:

```markdown
# Hello world May 28, 2026 Today is the first day of the rest of my blog.
```

To create a list of posts on your homepage, use a path glob pattern:

```markdown
# My website Read my blog: /blog/**
```

Vowel sorts pages by date, then alphabetically.

Embed a single page thumbnail by its URL:

```markdown
Check out my paella recipe: /recipes/paella
```

## Images

When you add full-sized images to your project folder, Vowel resizes and reformats them for optimal web serving.

![Keyboard](https://vowel.cc/images/keyboard-0cdf9193-1920.jpg)

All text is a typed language.

It also works for images on popular image CDNs:

![Airport](https://littlefair.imgix.net/cdg.jpeg?fm=jpeg\&w=1920\&fit=min)

This image is hosted on Imgix.

To add a caption, put your text on the line immediately after the image:

```
![Keyboard](images/keyboard.jpg) Qwerty is life.
```

## Customization

Site settings go in the frontmatter of `settings.md`:

```yaml
--- name: Example Website Name domain: example.com logo: example-logo.svg wordmark: example-wordmark.svg theme: Default ---
```

`theme` is `Default`, `Typography` or `Reset`:

- `Reset`: A simple CSS reset
- `Typography`: A reset and some typographic defaults
- `Default`: A simple website theme with utility variables

Vowel will automaticall link styles in `styles.css` to all pages in the same folder and subfolders. Theme styles are wrapped in CSS layers, so your rules always take priority.

## Deploy

The build is plain static files, so any static host works. Your files are cached in the system library. You can also export them to a specific directory:

```bash
vowel export ../my-site
```

Vowel has a built-in integration for Cloudflare Pages.

Name your project in `settings.md`:

```yaml
cloudflare_project: my-site
```

Then deploy:

```bash
vowel --command deploy
```

Read the [documentation](https://vowel.cc/docs) to learn more.
