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

First we need to install a dependency.

pip install pygments

The contents of mkdocs.yml now are listed below.

site_name: My Docs
theme:
  name: material
  palette:
    primary: purple
    accent: cyan
  font:
    text: Ubuntu
  logo: 
    icon: cloud
markdown_extensions:
  - codehilite:
      linennums: true

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

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