Skip to content

2025

Trust Your Tools: Stop Reinventing the Wheel in MkDocs

Have you ever spent hours fighting with a code formatter just to get a perfectly indented Table of Contents in your Markdown files? We've all been there.

Recently, I found myself wrestling with Prettier and EditorConfig just to maintain a 2-space indented list for a ## Table of Contents section in a Python documentation file. After configuring .editorconfig, creating a .prettierrc, and tweaking Prettier-ignore blocks to prevent my manual Table of Contents from getting mangled... I had a moment of clarity.

Why was I doing this manually when I'm using MkDocs?