Skip to content
Extremely simple static blog generator
Go Makefile HTML Dockerfile CSS
Branch: master
Clone or download

README.md

Build Status Docker Cloud Build Status

Underblog

An extremely simple, fast static blog generator.

Install

On MacOS:

brew install freetonik/tap/underblog

Docker:

docker run --rm -it -v /path/to/your/blog:/blog freetonik/underblog

Windows:

Go to releases and download the latest binary marked "windows".

How it works

You only need 4 things:

  1. index.html template for blog's index page.
  2. post.html template for single post.
  3. css/styles.css for CSS styles.
  4. markdown folder.

There is no front-matter. Date and slug are derived from the filename. Title is derived from the first line of markdown file. Make sure the first line starts with #.

Step 1: create the following folder structure:

.
├── css
│   └── styles.css
├── markdown
│   └── YYYY-MM-DD-Slug_1.md
│   └── YYYY-MM-DD-Slug_2.md
│   └── YYYY-MM-DD-Slug_3.md
├── index.html
├── post.html

(See /example)

Step 2: run underblog.

Step 3: Your site is generated in public.

Live preview

Run underblog in watch mode:

underblog -watch

Then go to http://localhost:8080/. Changing markdown files will automatically re-generate the site.

Features

  • NO front matter
  • NO themes
  • NO JavaScript
  • NO tags, categories, taxonomy
  • NO template lookup logic
  • NO plugins
  • NO dependencies

Roadmap

  • derive dates from filenames
  • RSS generation
  • Syntax highlighting for code with Chroma
  • live preview server (?)

Building

In the root repository do:

make build

You can’t perform that action at this time.