| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
| Name | Name | Last commit date | ||
|---|---|---|---|---|
User and SDK documentation for theprototype.app, built with MkDocs Material and published to docs.theprototype.app.
| Branch | Role |
|---|---|
| docs | default — the source. Markdown under docs/, config in mkdocs.yml, theme overrides in overrides/. |
| gh-pages | build output, written by mkdocs gh-deploy. Never edit by hand. |
The custom domain comes from the CNAME file.
python -m venv ./venv
# Windows
.\venv\Scripts\activate
# macOS / Linux
source venv/bin/activate
pip install -r requirements.txt
mkdocs serve # http://127.0.0.1:8000, live reloadGrab an installer from python.org/downloads/windows and make sure "Add python.exe to PATH" is ticked. If you used the embeddable build, pip comes from get-pip.py.
mkdocs gh-deploy --forceBuilds the site and force-pushes it to gh-pages; GitHub Pages serves it within a minute or so. Commit your Markdown changes to docs as well — gh-deploy only touches the built output.
| Back | FazBrowse Home | New Git URL |