mkdocs:
material 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.
Notes
We first need to install new themes.
pip install mkdocs-material
If you're using a modern version of mkdocs
then you need the
following settings to achieve the same result:
site_name: My Docs
theme:
name: material
palette:
primary: purple
accent: cyan
font:
text: Ubuntu
icon:
logo: material/cloud
This is different than the file in the video because mkdocs-material
has gone through an update. The mkdocs.yml
file in this video
contains the following code:
site_name: My Docs
theme:
name: material
palette:
primary: purple
accent: cyan
font:
text: Ubuntu
logo:
icon: cloud
Note that the color settings, font settings and icon settings can be reviewed in the documentation found here.
Feedback? See an issue? Something unclear? Feel free to mention it here.
If you want to be kept up to date, consider signing up for the newsletter.