A static website hosted by GitHub Pages.
We're using GitHub's Actions, so any push to the main branch triggers a build of the HTML. Those are put into the gh_pages branch
Results are published to weeklydevchat.github.io
Requirements:
- Python (any recent should be fine. Recommended to use a virtual environment.)
-
Material for MkDocs
pip install mkdocs-material
-
Material for MKDocs is a theme and plugin package for MkDocs. Visit both sites for complete information.
mkdocs serve
- Start the live-reloading docs server. Use this to test changes locally before pushing.mkdocs -h
- Print help message and exit.
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
posts/ # blog posts, organised anyway you like
... # Other markdown pages, images and other files.
If you want to develop using Docker run the following command:
docker compose up app
This will bring the application up on port 8000 (e.g. http://localhost:8000). It should hot-reload any changes you make during development.