README.adoc

PAPRa Docs

This repository contains the content and source code for generating the PAPRa site.

Running the website locally

You can build and serve the documentation site on a local desktop:

Note: It is recommended you run the following instructions on a Linux/Unix-like operating system. If you are on a Windows machine, consider installing Windows Subsystem for Linux.

Installing requirements

You will need git to clone the project contents and podman to run the podman image that contains the dependencies needed for building the documentation.

1. git.

2. podman.

Cloning the repo

Clone the PAPRa repo. Don’t forget to use --recurse-submodules flag, or else you won’t pull down some of the code you need to generate a working site.

git clone --recurse-submodules https://github.com/tetrabiodistributed/papra.git
cd papra

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.

Building the documentation

Once you’ve cloned the repo & installed podman, run the build.sh script in the project root directory. This will pull the podman images, as well as install node modules, needed for generating the papra page locally. You can view all locally installed podman images by running podman images.

./build.sh

Run the serve.sh script in the site root directory. By default, your site will be available at http://localhost:1313/papra.

./serve.sh

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

Licensing

Code licensed MIT

Docs licensed CC BY 4.0