Getting Started

Getting Started #

Install dependencies #

To contribute to the handbook you will need

Git
Hugo (You will need the extended version with Sass/SCSS support)
Your favourite text editor
Optionally pre-commit; see Making Changes for more details.

Clone the repository #

Clone the repository with one of the following options (depending on how you authenticate with GitHub):

SSH authentication

git clone --recurse-submodules git@github.com:alan-turing-institute/REG-handbook.git
cd REG-handbook

HTTPS authentication

git clone --recurse-submodules https://github.com/alan-turing-institute/REG-handbook.git
cd REG-handbook

The --recurse-submodules flag is important as the handbook’s theme is included as a Git submodule.

Serve the handbook locally #

While working on the handbook, it will be useful to preview your changes locally. To do this use Hugo’s server command

hugo server --minify

In the output of this command will be a line similar to

Web Server is available at http://localhost:1313/REG-handbook/ (bind address 127.0.0.1)

which contains the URL of the locally served site. Navigate to this address in your browser to preview the handbook.

The Hugo server will monitor the files in the repository and automatically rebuild the site whenever you make changes. This is a useful tool to immediately view your changes.