Add instructions for running a local development instance of the wiki

This commit is contained in:
Al Bowles 2023-06-28 14:37:15 -05:00
parent 7c2c1ba146
commit c8c1b44607
No known key found for this signature in database
GPG Key ID: 9B42314A30F1A3D1

View File

@ -7,3 +7,15 @@ https://testing.rocky.page
## Continuous Integration / Continuous Deployment ## Continuous Integration / Continuous Deployment
Actions Runner executes workflow to publish to https://testing.rocky.page on push to main. 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.