Skip to content
This repository has been archived by the owner on Jan 25, 2019. It is now read-only.
mythmon edited this page Sep 8, 2011 · 30 revisions

wok

Wok is a static website generator. It turns a pile of templates, content, and resources (like CSS and images) into a neat stack of plain HTML.

The idea is that you don't need a big server-side engine like PHP to generate every page every visit: you can generate them all ahead of time, and only regenerate things when something has changed. A good way this could be done would be with a post-commit hook on a git repository containing your content or layout.

I made wok because projects like Jekyll, Hyde, and Static were intriguing, but in the end didn't quite match what I wanted to do with my website. So I am writing my own.

Tutorial

Read it

Features

  • Processes content and templates, and renders them to a set of pure HTML.
  • Provides tagging and a hierarchical category system for organizing pages.
  • Handles all kinds of media and other site resources (like images, CSS, JavaScript files, etc.) automatically.
  • Includes a simple development server.
  • Supports pagination.

Planned features

  • Only regenerates pages that need it.
  • Support for more markup languages (next up: ???)

Usage

To use wok, go to the directory where your site files are located, and run:

wok

If it returns without an error, you should have a shiny new output folder containing a clean set of HTML, and any site resources placed in the output folder. For more details, see the tutorial, and the rest of the documentation.

Documentation

More detailed information about wok.

Clone this wiki locally