Documentation Setup

Repo & Hosting

This project is built using MKdocs markdown, housed in GitHub, and hosted as a static site on Netlify.

To develop documentation locally, you need to install mkdocs which is a Python package. You can create a Python virtual enviroment using Anaconda Navigator.

Next create a new virutal env named USAHello-docs and initialize the env.

Then install mkdocs in conda

conda install -c conda-forge mkdocs

Clone the repo from GitHub

If you want to run a local version of the documentation that will live-reload any changes run:

mkdocs serve

The dev site is availabe at http://localhost:8005.

Deployment

To deploy your changes simply push your changes to the repo and Netlify will build the site.