Documentation

CLI

vowel builds a website, serves a preview on localhost, and watches for changes.

• --skip: Skip setup wizard
• --verbose: Log activity to terminal

Settings

To configure any of these settings, add a property to the appropriate file's yaml frontmatter.

Website

The settings.md file can contain the following properties:

• domain: Domain of deployed website (for sitemap)
• title: Website title
• author: Website author (for RSS feed)
• tagline: Short description of website
• icon: Path to favicon
• theme: A Vowel theme
• logo: Path to a logo file
• wordmark: Path to a wordmark file

Vowel will ignore any other properties.

Page

Any page can contain the following properties:

• title
• description
• image
• date
• breadcrumb

Vowel will ignore any other properties.

Vowel may also metadata based on context.

• title: An h1 near the top of the file
• image: The first image in the file
• date: A plain-language near near the top of the file
• breadcrumb: The file's name

Themes

Vowel includes three CSS themes. To set a theme, list one in settings.md:

theme: Default

To add custom styles, include a styles.css file. All rules in styles.css will take priority over theme styles, as the theme styles come wrapped in CSS layers.

Reset

A basic CSS reset.

Typography

The Reset theme with some simple typographic defaults.

Default

Reset, typography, and layout.