logo


mkdocs


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


1 - Intro to Mkdocs
Setting it up.
2 - Making Pages
3 - Effect of Folders
4 - Hosting Images
5 - Style and CSS
6 - Material Mkdocs
7 - CodeHilite
8 - Footnotes
9 - Extras

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.