Documentation Tools

Here are the tools I use:

MkDocs#

I use MkDocs + MkDocs Material.

I have a few dislikes:

• The mkdocs-material theme turns 50% 1080p displays to mobile. I have fixed this in my fork.
• mkdocs-material is EOL November 2026. (I'm not worried, it's a SSG)

Ultimately I find it a workable solution for the time being, it searches well, highlights code, and works well in CICD to generate this very site!

You can get started using mkdocs here: https://squidfunk.github.io/mkdocs-material/getting-started/

Read here for my setup: link

Read here for my common snippets: link

VSCode Documentation Setup#

I use VSCode with a few plugins to help:

• Notes to keep my mkdocs project always accessible.
• Todo Tree to manage stubs for things I'll insert later.
• Paste Image to paste images.
• Simple Hide Files to keep mental load low.

• Highlight (Markdown Previews) to color monospace blocks for easier writing.

• A few global markdown snippets to make mkdocs management easier.

My config can be found here.

Recording & Capture#

I use as little tools as possible and keep it as close as possible to immediate capture and record.