From c8c1b446070b10799392cda8ce3d429897ff2272 Mon Sep 17 00:00:00 2001 From: Al Bowles Date: Wed, 28 Jun 2023 14:37:15 -0500 Subject: [PATCH] Add instructions for running a local development instance of the wiki --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9ea2d0b..108170e 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,15 @@ https://testing.rocky.page ## Continuous Integration / Continuous Deployment Actions Runner executes workflow to publish to https://testing.rocky.page on push to main. + +## Local Development + +To run a local instance of the wiki for development purposes, do the following: + + # Install dependencies + pip3 install -r requirements.txt + + # Run the local mkdocs server + mkdocs serve + +The wiki will be available at http://127.0.0.1:8080 and will refresh automatically when edited files are saved.