# Vowel

https://vowel.cc/

Why would you use it? Because it is fast and it makes websites that are also quite fast.

> [!NUMBER] 10s
> Convert 1000 markdown files to HTML in under 10 seconds.

> [!NUMBER] 1s
> Open a cached build with 1000 markdown files in under a second.

> [!NUMBER] 100ms
> Detect a change to a file and update the page in under 100 milliseconds.

> [!NUMBER] 4x100
> Score 100s across the board on Google PageSpeed.

> [!NUMBER] 0kb
> Ship pages with 0 JavaScript.

> [!NUMBER] 12kb
> Fit your HTML in a single 12kb packet.

Why else would you use it? Because it's easy and it gives you the tools to do make all sorts of things.

Take a look at the code for a webpage:

```md title="Blog/Hello World.md"
--- style: ./hello-world.css # Custom styles atproto_lexicon: example.example.lexicon # AT Protocol publishing --- # Hello World January 3, 2022 <!-- Natural language date inferrence --> #baking <!-- Tag pages --> ![Fresh baked cookies](./huge-image-file.jpeg) <!-- Image optimization --> Fresh out of the oven. <!-- Image captions --> This week I'm baking some cookies :icons/cookie:. <!-- Icon shortcodes --> See my previous [[Cookie Recipes]]: <!-- Wikilinks --> /recipes/cookies/* <!-- Glob listings --> The recipe is based on one from my friend Suzy: https://example-suzy.com <!-- Link embeds --> Her cookies look beautiful: ![Suzy's cookies](https://cloudinary.com/suzy/cookie.jpg) <!-- CDN image optimization --> Find special cookie tips on my [secret recipe page](/bonus-recipes##secret-key.md). <!-- Hidden pages --> If you like my recipes, please [subscribe via RSS](/feed.xml)! <!-- RSS feed -->
```

Vowel runs with no config and one command:

```bash
# node@^26 cd your-website npx vowel@latest
```

## High standards

Vowel implements all of the modern best practices on the web, from GFM to a11y.

> [!CARD] Markdown
> CommonMark and GFM with features like highlights, footnotes, and alerts.

> [!CARD] Templates
> Clean, minimal markup written in semantic HTML.

> [!CARD] Images
> Full `srcset` generated from full-sized images for optimal serving.

> [!CARD] A11y
> Semantic HTML following best practices.

> [!CARD] Optimization
> Markup tailored for SEO and AIO.

> [!CARD] Discovey
> Automatic sitemap.

> [!CARD] Policies
> Block or allow bots and scrapers in `robots.txt`.

> [!CARD] Portable
> Plain markdown in, plain HTML out.

> [!CARD] Minification
> Optimized HTML and CSS.

## Forgettable syntax

Vowel makes most common operations so easy you'll feel like there's nothing new to learn.

> [!CARD] Frontmatter
> Declare anything you want in YAML frontmatter.

> [!CARD] Metadata
> Smart detection for date, breadcrumb, title, image, and description.

> [!CARD] Dates
> Natural language date parsing, like `28 May 2026`.

> [!CARD] Folder dates
> Folder-name date parsing, like `2023/04/07.md`.

> [!CARD] Contents
> Headings table generated for every page.

> [!CARD] Links
> `[[Wikilinks]]`, `./../relative-links`, `/absolute-links`, and `#hashtags`.

> [!CARD] Globs
> Page lists with `blog/*` and `blog/**`.

> [!CARD] Tagging
> `/tags/*` pages for `#hashtags` and `#nested/hashtags`.

> [!CARD] Indexes
> An index page for every folder.

> [!CARD] Emoji
> Emoji shortcodes like `:tada:` for 🎉.

> [!CARD] Icons
> Shortcode references to local SVGs like `:skater:` for 🛹.

> [!CARD] Code
> Syntax highlighting with highlight.js.

## Speed for need

Vowel builds your website in seconds, makes updates in milliseconds, and publishes to Cloudflare and atproto with a single command.

> [!CARD] Caching
> SQLite caching with incremental regeneration for millisecond updates.

> [!CARD] Live preview
> Changes in real time.

> [!CARD] Free hosting
> Deploy directly to Cloudflare Pages on their unlimited free tier.

## Friendly requests

Vowel integrates with the social web.

> [!CARD] Thumbnails
> Internal and external link preview cards.

> [!CARD] Syndication
> Automatic RSS.

> [!CARD] Atmosphere
> Publish directly to atproto in any lexicon.

> [!CARD] Blogging
> Primitives for blogs (post lists, dated posts, and RSS).

> [!CARD] Socials
> List of social links or icons.

> [!CARD] Universal
> Designed for Mac, Linux, and PC.

## Free expression

Vowel takes care of the grunt work and lets you have fun with the creative parts.

> [!CARD] Themes
> Built-in themes for fast fashion.

> [!CARD] Colors
> Magic color themeing with colorhorse.

> [!CARD] Fonts
> Ramp settings for heading font size, spacing, and weight.

> [!CARD] Variables
> Convenient CSS variables for custom styling.

> [!CARD] Stylesheets
> Custom CSS for every or any page.

> [!CARD] 404
> Customizabe 404 page.

> [!CARD] Secrets
> Hidden folders and pages for discrete publishing.

> [!CARD] Branding
> `logo` and `wordmark` in the header.

> [!CARD] Classes
> HTML utility classes like `body.page_about` and `ul.folder_docs`.

> [!NOTE] How do I apply templates?
> Vowel is an unusual static site generator. It provides the templates for you. That means you cannot freely restructure the HTML.
>
> Why doesn't Vowel allow templating?
>
> This is a core part of the philosophy of Vowel. Many HTML structures already have a well-understood correct implementation with consideration for SEO, performance, and a11y. Vowel provides all of those templates for you.
>
> Moreover, you might not need templates in order to customize your site. Modern CSS has eliminated the need for many templating workarounds. Vowel keeps templates simple with concise, semantic, accessible HTML that lends itself to endless customization with YAML, markdown, and CSS.
>
> Imagine a world where you never need to write PHP, handlebars, or JSX ever again.

Want to start building?

Proceed with the [quickstart](https://vowel.cc/quickstart).
