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 pymdown-extensions

The contents of mkdocs.yml is listed below.

site_name: My Docs
theme:
    name: material
    palette:
        primary: blue
        accent: cyan
    font:
        text: 'Ubuntu'
    logo:
        icon: 'cloud'
extra_javascript:
  - 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-MML-AM_CHTML'
markdown_extensions:
  - pymdownx.arithmatex
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_generator: !!python/name:pymdownx.emoji.to_svg
  - footnotes
  - codehilite:
      linenums: 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. 

### Demo :smile:

## Roadmap

* [x] wake up 
* [x] have coffee
* [ ] work

## Maths 

I can do some maths $a + b < c$ inline. 

$$ a + c^2 < b^7 $$

[^1]: From a pydata video, can be found [here](https://www.youtube.com/watch?v=Z8MEFI7ZJlA&t=943s).

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

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