/wyam-docs

An example project documentation static site built with Wyam.

Welcome to the WyamDocs example repository!

Purpose

This repository is an example of a project documentation site built using Wyam, a static content generator and toolkit.

Rules of the Repository

  • Master branch is production, period.
  • Do not commit to master, please work off the development branch.
  • When working locally, try to work in feature branches.
  • Please follow GitFlow.
  • You may fork this repository freely, for personal or commerical use. It would be cool if you dropped my name in some credits, but it's not required.

How to Run

Preview Mode

  • After cloning this repo, you can build this site and see a preview of it with the following command: wyam build -p

Production Mode

wyam build