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.
First we need to install a dependency.
pip install pygments
The contents of
mkdocs.yml is listed below.
site_name: My Docs theme: name: material palette: primary: purple accent: cyan font: text: Ubuntu logo: icon: cloud markdown_extensions: - footnotes - codehilite: linennums: true
The contents of the
backend.md file is listed below.
# Backend Our backend is written in python and go. We have some coding habbits. !(/images/img.png) This image[^1] demonstrates something interesting. ```python for i in range(10): print(i)
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.