Quickstart

This guide gets you running with a minimal setup and a working example.

Prerequisites

• A GitHub account
• A project repo with GitHub Pages enabled
• A local clone of the repo

Step 1. Confirm Pages settings

Open the repository settings and ensure Pages is set to deploy from the main branch at the root folder.

Step 2. Add your first page

Create an index.md in the repo root (already done) and commit it. This file becomes your homepage.

Step 3. Configure the site

Edit _config.yml to set title, description, url, and a supported theme.

Step 4. Verify the build

Wait for the Pages build to complete, then load the custom domain in your browser.

Next steps

• Browse the sample projects to adapt a pattern quickly.
• Add a new guide under docs/ as you document features.

Explore sample projects