-
Notifications
You must be signed in to change notification settings - Fork 79
Lab writer's guide
Copilot Camp uses MkDocs to generate a static web site that contains the labs and other instructions. The labs themselves are written in MkDocs Markdown. Whatever markdown files are in the docs folder in the main branch will be compiled by github and posted at https://microsoft.github.io/copilot-camp/.
Lab editors should fork the copilot-camp repo. When your edits are complete, submit a pull request to the main branch.
For local testing, you can install mkdocs on your computer and view the pages locally, even as you are working in a branch:
- Follow the instructions to install mkdocs: https://www.mkdocs.org/user-guide/installation/
- Install material for mkdocs: https://squidfunk.github.io/mkdocs-material/getting-started/
- At the root of the app-camp repo, run
mkdocs serve
- Navigate to http://localhost:8000 to view the instructions; the browser will refresh automatically when you save your file
If you want to serve to an external IP address on port 80 instead of just localhost:8080, use this command. This is handy for viewing the site on a 2nd machine while you are editing.
python -m mkdocs serve --dev-addr=xxx.xxx.xxx.xxx:80