testing/wiki
10
0
Fork 3
generated from sig_core/wiki-template
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Merge pull request 'Add instructions for running a local development instance of the wiki' (#4) from dev_setup into main
All checks were successful
mkdocs build / build (push) Successful in 27s
Details

Browse Source 
Reviewed-on: #4
This commit is contained in:
Al Bowles 2023-06-29 17:45:42 +00:00
commit 1b750f05f1
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
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.