Skip to content

Blog

Technical writing with material for mkdocs

Abstract

Material for mkdocs is a documentation framework adopted by many popular python libraries e.g. this, this and this. The plugins and markdown extensions make writing rich technical content delightful e.g. maths, code, docstring parsers, and more. The main apeal of the project is that "it's just markdown" (with a bit of extended syntax). This tutorial provides a step by step intro to setting up a blog website (such as this one!) with this framework.