Client Docs Template

Template project to use for creating client merchant docs

Requirements

• GIT
• Hugo (v0.100.2 extended)

Usage

Download/Clone

The client docs template uses a GIT submodule for its theme. Therefore, when cloning the repository ensure you do so recursively:

git clone --recurse-submodules git@github.com:rehive/client-docs-template.git

When pulling new changes from master make sure you also run the following afterwards to get the latest submodule updates.

git submodule update

If a submodule has been updated at its origin, then you will need to merge these updates into the repository using:

git submodule update --remote --merge

And then commit/push the new submodule.

Development

To run the hugo server:

hugo serve

To build the static files:

hugo

Please take a look at the Hugo Documentation for additional usage.

Configuration

Update the configuration in the config.yaml with apropriate values.

Update the references in the content/checkout/_index.md file.