Compose

Compose is a Hugo theme for documentation sites, that provide simple navigation & structure.

Prerequisites

The following are basic prerequisites for using compose in your site:

• Install a recent release of the Hugo "extended" version (we recommend version 0.61 or later). If you install from the
  release page, make sure you download the _extended version
  which supports sass.

Example and usage

You can find an example project that uses Compose in the Compose Example Project repo.

The Compose Example Project is hosted at https://compose-docs.netlify.com. This project also stands as the theme's user guide.

This guide covers the necessary bits. As the project evolves, the userguide will get more comprehensive

You can use Hugo to generate and serve a local copy of the guide (also useful for testing local theme changes), making sure you have installed all the prerequisites listed above:

git clone --recurse-submodules --depth 1 https://github.com/onweru/compose.git
cd compose/exampleSite/
hugo server --themesDir ../..

Note that you need the themesDir flag when running Hugo because the site files are inside the theme repo.