Налаштування Material for MkDocs
Material for MkDocs — найповна тема для MkDocs з версіонуванням (Mike), аналітикою, Social Cards, Tags та розширеною навігацією.
Установка та базова конфігурація
pip install mkdocs-material
# Додаткові плагіни
pip install mkdocs-git-revision-date-localized mkdocs-minify-plugin mike pillow cairosvg
Розширений mkdocs.yml
theme:
name: material
custom_dir: overrides # для переопределення шаблонів
logo: assets/logo.svg
favicon: assets/favicon.png
font:
text: Inter
code: JetBrains Mono
features:
- announce.dismiss
- content.action.edit
- content.action.view
- navigation.footer
- navigation.indexes
- navigation.path # хлібні крошки
- navigation.prune
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
extra:
version:
provider: mike # версіонування
social:
- icon: fontawesome/brands/github
link: https://github.com/my-org/my-project
analytics:
provider: google
property: G-XXXXXXXXXX
feedback:
title: Ця сторінка корисна?
ratings:
- icon: material/thumb-up-outline
name: Так, корисно
data: 1
note: Спасибо!
- icon: material/thumb-down-outline
name: Ні, потребує поліпшення
data: 0
note: Напишіть нам!
Social Cards
plugins:
- social:
cards_layout_options:
background_color: "#1e293b"
color: "#ffffff"
font_family: Inter
Версіонування через Mike
pip install mike
# Деплой версії
mike deploy --push --update-aliases 2.0 latest
mike set-default --push latest
# Список версій
mike list
Кастомізація через overrides
<!-- overrides/main.html -->
{% extends "base.html" %}
{% block announce %}
<div class="md-banner">
🎉 Версія 2.0 вийшла! <a href="/changelog">Що нового</a>
</div>
{% endblock %}
{% block styles %}
{{ super() }}
<link rel="stylesheet" href="{{ 'assets/custom.css' | url }}">
{% endblock %}
Tags плагін
plugins:
- tags:
tags_file: tags.md # сторінка зі всіма тегами
# У Markdown:
---
tags:
- API
- Authentication
- Python
---
Повна налаштування Material for MkDocs — 4–8 годин.