Diátaxis Material for MkDocs Guide

Welcome to a practical documentation project for Material for MkDocs, organized using the Diátaxis framework.

What is MkDocs

MkDocs is a static site generator designed for project documentation. It builds a website from Markdown files and a simple configuration file, making it easy to create and maintain documentation.

What is Material for MkDocs

Material for MkDocs is a popular theme and feature-rich extension for MkDocs. It adds a modern dark-themed design, improved search, new UI features and more.

What is Diátaxis

Diátaxis is a documentation framework that organizes content into four distinct types: tutorials, how-to guides, reference, and explanation.

Overview

As the Diátaxis framework has four quadrants, this documentation is organized accordingly: