Skip to content

tetrabiodistributed/tetra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

b1837ad · Sep 29, 2021

History

63 Commits
Jul 17, 2020
Jun 9, 2020
Sep 29, 2021
Jun 26, 2020
Nov 7, 2020
Jun 8, 2020
Nov 22, 2020
Aug 16, 2020
Aug 5, 2020
Jun 8, 2020
Aug 21, 2021
Oct 29, 2020
Aug 14, 2021
Jul 17, 2020
Jun 17, 2020
Oct 29, 2020

Repository files navigation

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:

  1. Install docker.

  2. 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/tetra.git
    cd tetra

    Note: If you accidentally cloned without using --recurse-submodules, you can run git submodule update --init --recursive to pull down submodules needed to generate a working site.

  3. Run the build.sh script in the site root directory (Note: Linux users may need to prepend this command sudo). This will build a docker image, as well as install node modules, needed to locally run the tetra 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 running docker images.

    ./build.sh
  4. Run the serve.sh script in the site root directory (Note: Linux users may need to prepend this command sudo). By default, your site will be available at http://localhost:1313/tetra.

    ./serve.sh
  5. Now that you’re serving your site locally, Hugo will watch for changes to the content and automatically refresh your site.