We use Hugo to format and generate our website, the Docsy theme for styling and site structure, and Netlify to manage the deployment of the site. Hugo is an open-source static site generator that provides us with templates, content organisation in a standard directory structure, and a website generation engine. You write the pages in Markdown (or HTML if you want), and Hugo wraps them up into a website.
We use GitHub pull requests for submitting changes. Consult GitHub Help for more information on using pull requests.
Here’s a quick guide to updating the docs. It assumes you’re familiar with the GitHub workflow and you’re happy to use the automated preview of your doc updates:
If you’ve just spotted something you’d like to change while using the docs, Reva has a shortcut for you:
If you want to run your own local Hugo server to preview your changes as you work:
npm install postcss-cli to have the right tools installed.
Fork the Reva repo repo into your own project, then create a local copy using
git clone https://github.com/me/reva.git
git submodule update --init --recursive
hugo server in the site root directory:
By default your site will be available at http://localhost:1313/. Now that you’re serving your site locally, Hugo will watch for changes to the content and automatically refresh your site. 1. Continue with the usual GitHub workflow to edit files, commit them, push the changes up to your fork, and create a pull request.
If you’ve found a problem in the docs, but you’re not sure how to fix it yourself, please create an issue in the Reva repo. You can also create an issue about a specific page by clicking the Create Issue button in the top right hand corner of the page.