vraer / website-wiki-sandbox

Sandbox for developing and previewing updates to hackforla.org's website wiki

HFLA Website Wiki Sandbox

This repo contains a MkDocs documentation site for collaboratively building the HFLA website wiki in a sandbox environment.

Installation

With Docker

The quickest way to run the site is using Docker:

docker pull vraer/hfla-website-wiki-sandbox:latest
docker run -p 8000:8000 vraer/hfla-website-wiki-sandbox:latest

The site will now be running at http://localhost:8000.

With Python virtualenv

Alternatively, you can install locally using Python:

python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt 
mkdocs serve

About

This sandbox site has GitHub discussions integrated for easy collaboration.

Note this currently only contains a subset of pages from the main HFLA website wiki repo as an example. More existing wiki content can be migrated over later for review.