Install

Paste this into your terminal to install Poblano in one line.

curl -fsSL https://raw.githubusercontent.com/isaacpeterklein/poblano/master/install.sh | sh

Quick Start

Three commands to go from nothing to a running site.

poblano new mysite
poblano build
poblano serve

poblano new creates a starter mysite.pob file. poblano build compiles it into a dist/ folder. poblano serve builds, serves at localhost:3000, and watches for changes.

Commands

All available CLI commands.

poblano new <name>     Create a new starter .pob file
poblano build            Compile to dist/
poblano build <file>   Build a specific .pob file
poblano serve            Serve at localhost:3000 and watch for changes
poblano serve <file>   Serve a specific .pob file

File Format

A .pob file is plain text. Sections are separated by blank lines. The first line of each section is the keyword. Lines after that are the content.

config
primary #4f46e5
site-name My Site
header
home about contact
home
hero
Welcome
A subtitle here.
card
My Card
Some body text.

Config Block

The config block sets global options for your site. It should be the first block in your file.

config
primary #6d28d9
accent #a855f7
font Inter
dark-mode false
site-name My Site
logo /logo.png
favicon /favicon.ico

All keys are optional — anything you leave out falls back to a default. primary and accent are hex colors. font is any Google Font name. dark-mode accepts true or false.

Header Block

The header block defines your navbar. Each word becomes both a page and a nav link. Order matters — it controls the order links appear in the nav.

header
home about projects contact

Every word listed here needs a matching page section further down in the file, or Poblano will warn you at build time.

Pages

A page section starts with the page name matching one of your header items. Everything below it (until the next page) belongs to that page.

about
hero
About Me
I build things.
card
Background
I have been writing code for 8 years.