MkDocs Site for Developers #156
Description
📋 User requirements
AS A Scaf fullstack template user
I WANT a MkDocs site in the development environment at /docs in the url
SO THAT I can easily browser project documentation, including mermaid diagrams, with live reload
✅ Acceptance criteria
GIVEN that I have an MkDocs site in teh template running as a service in the cluster
WHEN I navigate to localhost/docs (or similar) after bringing up a development cluster
THEN I will see the project documention
AND the documenation will be themed with Material for MkDocs
AND Mermaid diagrams will be visable and support pan, zoom, etc.
🛸 Out of scope
No response
📝 Additional context (Optional)
pip packages that can do this:
- mkdocs
- mkdocs-material
- mkdocs-mermaid2-plugin
- mkdocs-panzoom-plugin>=0.2.2
🕸️ Dependencies (Optional)
No response
🖼️ Wireframe (Optional)
No response