How squidfunk/mkdocs-material works
Material for MkDocs is a MkDocs theme and plugin suite for turning Markdown documentation into a searchable static site. The main workflow is authoring Markdown and having MkDocs render it; the repository also supplies search, blog, project, tags, social-card, privacy, offline, optimization, and other extensions. The tree contains parallel src and material packages; nodes retain key source-index modules from both. Relationships are limited to README and source-index references or visible calls; unsampled plugin wiring is not inferred.
Main entry points: plugin.py Search index · __init__.py File filtering · parser.py Read-time parser · handler.py Project watcher
Components 24
Theme and authoring
- Material theme
material/templates/__init__.py
Content features
- Blog Markdown structure
src/plugins/blog/structure/markdown.py - Blog plugin
material/plugins/blog/plugin.py - Read-time parser
material/plugins/blog/readtime/parser.py - Projects plugin
material/plugins/projects/plugin.py - Project watcher
material/plugins/projects/builder/watcher/handler.py - Tags plugin
material/plugins/tags/plugin.py
Site enhancements
- Search index
material/plugins/search/plugin.py - Info plugin
material/plugins/info/plugin.py - Social cards
material/plugins/social/plugin.py - Metadata plugin
material/plugins/meta/plugin.py - Privacy parser
material/plugins/privacy/parser.py - Offline plugin
material/plugins/offline/plugin.py - Optimization plugin
material/plugins/optimize/plugin.py - Typesetting plugin
material/plugins/typeset/plugin.py - File filtering
material/utilities/filter/__init__.py - Link previews
material/extensions/preview.py - Emoji extension
material/extensions/emoji.py
Mirrored source modules
- Search source
src/plugins/search/plugin.py - Social-card source
src/plugins/social/plugin.py - Info source
src/plugins/info/plugin.py - Filter source
src/utilities/filter/config.py
Other components
- Documentation author
- MkDocs renderer
Connections 10
- Documentation author → MkDocs renderer: authors Markdown
README.md - MkDocs renderer → Material theme: uses theme
- MkDocs renderer → Search index: loads plugin
- Project watcher → Projects plugin: schedules build
material/plugins/projects/builder/watcher/handler.py - Link previews → File filtering: filters links
material/extensions/preview.py - Read-time parser → Search index: imports void tags
material/plugins/blog/readtime/parser.py - Info plugin → Info source: mirrored implementation
- Search index → Search source: mirrored implementation
- Social cards → Social-card source: mirrored implementation
- File filtering → Filter source: mirrored implementation