There's a much cleaner mkdocs
under the hood, waiting to be let out.
This is a space for design exploration.
At the same time we also need to continue to improve mkdocs as it currently stands. I'm planning on taking a dual approach here...
- Incremental improvements to the existing
mkdocs
. (As a minimum the default theme needs freshening up.) - Explore this design space, and determine how we can best move forward in places where more fundamental changes are required.
TODO: Expand on this.
https://github.com/mkdocs/insiders/blob/main/mkdocs/site.py
Safe rendering, avoid Python knowledge as a dependancy.
Onboarding etc.
git clone https://github.com/encode/httpx
cd httpx
python -m venv venv
venv/bin/pip install git+https://github.com/mkdocs/sketch
venv/bin/mkdocs serve
![image](https://private-user-images.githubusercontent.com/647359/331656015-d94d3325-750c-4c13-a4fb-60c1422173d7.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3Mzg5NzI2NzksIm5iZiI6MTczODk3MjM3OSwicGF0aCI6Ii82NDczNTkvMzMxNjU2MDE1LWQ5NGQzMzI1LTc1MGMtNGMxMy1hNGZiLTYwYzE0MjIxNzNkNy5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjA3JTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIwN1QyMzUyNTlaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1hYjM5YjRkMGYwMDhjN2I0ZmQ0MzhkOTY5MGRlZTBjYzhjZTc4ZTNjODM1ZjlkNGU4NjU2NDg1YWZhMTRlNDlhJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.Iz6LH3ezXW4aOil4ugdb1NjnL4c0zh0mwXH1tJhISNE)
mkdocs serve
renders pages on the fly. There's no "build the whole site" process needed.- The context passed to the theme is completely cleaned up. I'll write about this as we go, there's a really clean clear data model that's passed through to the templating.
- More to come...