logo

... mkdocs.


Documentation is important. It goes further than readme files and it's often not just about code. Mkdocs is an awesome tool for it, it keeps the complexity at bay and there's some amazing plugins for it too.


Episode Notes

Make sure you first install mkdocs with pip.

pip install mkdocs

Once you've done that you can start a project locally via;

mkdocs new . 
mkdocs serve

If you make changes to the markdown files the website will automatically update.


Feedback? See an issue? Feel free to mention it here.

If you want to be kept up to date, consider getting the newsletter.