Skip to content

MKDocs Simple

What ⚡

A simple, default config for MKDocs with - Material Theme added - Markdown stored in default "docs" location - A github action config YAML that will convert the markdown files stored in "docs" to html, push them to an independent branch in this repository called "gh-pages" and then deploy this html to a free website hosted on Github's servers and domain name.

Why 🤷‍♂️

This is a simple, "control" before moving on with examples of how to alter this default to fit different personal prefrences, advanced workflows and make MKDocs work better with popular markdown notes tools like Obsidian or Zettlr, and many more.

How 📋

Learn more here: ____