Quick start

Build your first Basalt site from a directory of Markdown files. This guide takes about five minutes.

Create a new site

Run the init command to create a new project in a directory called my-site.

bash
basalt init my-site

Go into the directory

Change to the new project directory.

bash
cd my-site

Write a page

Create a file called index.md with the frontmatter title and some Markdown.

markdown
---
title: Home
---

# Hello, world.

This is your first Basalt page.

Start the dev server

Basalt serves your site at localhost:3000 and rebuilds when you change a file.

bash
basalt dev

Build for production

The build output goes to the _site directory by default.

bash
basalt build

Next steps

Read the command reference for a full list of commands, or edit src/pages/index.md to change your homepage.

Built with vibld