Project Tetra Docs
This repository contains the content and source code for generating the Project Tetra Docs site.
Running the website locally
You can run your own Hugo server using docker to preview the site locally:
-
Install docker.
-
Clone the Project Tetra docs repo. Don’t forget to use
--recurse-submodules
or you won’t pull down some of the code you need to generate a working site.git clone --recurse-submodules https://github.com/tetrabiodistributed/project-tetra-docs.git cd project-tetra-docs
Note: If you accidentally cloned without using
--recurse-submodules
, you can rungit submodule update --init --recursive
to pull down submodules needed to generate a working site. -
Run the
build.sh
script in the site root directory (Note: Linux users may need to prepend this commandsudo
). This will build a docker image, as well as install node modules, needed to locally run theproject-tetra-docs
Hugo webserver. Once the image is built and stored on your machine, you do not need to rerun this step. You can view all locally installed images by runningdocker images
../build.sh
-
Run the
serve.sh
script in the site root directory (Note: Linux users may need to prepend this commandsudo
). By default, your site will be available athttp://localhost:1313/project-tetra-docs
../serve.sh
-
Now that you’re serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.