Switch to mkdocs material theme

This commit is contained in:
Bruno Alla 2025-12-09 14:23:55 +00:00
parent 055c422b34
commit 3f5399b2b4
4 changed files with 60 additions and 3 deletions

BIN
docs/theme/img/favicon.ico vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 KiB

48
docs/theme/stylesheets/extra.css vendored Normal file
View File

@ -0,0 +1,48 @@
:root > * {
/* primary */
--md-primary-fg-color: #2c2c2c;
--md-primary-fg-color--light: #a8a8a8;
--md-primary-fg-color--dark: #181818;
/* accent */
--md-accent-fg-color: #c50d0d;
--md-accent-fg-color--light: #ff8f8f;
--md-accent-fg-color--dark: #A30000;
}
.md-header {
border-top: 5px solid var(--md-accent-fg-color--dark);
}
body hr {
border-top: 1px dotted var(--md-accent-fg-color--dark);
}
/* Cutesy quote styling */
[dir="ltr"] .md-typeset blockquote {
font-family: Georgia, serif;
font-size: 18px;
font-style: italic;
margin: 0.25em 0;
padding: 0.25em 40px;
line-height: 1.45;
position: relative;
color: #383838;
border-left: none;
}
[dir="ltr"] .md-typeset blockquote:before {
display: block;
content: "\201C";
font-size: 80px;
position: absolute;
left: -10px;
top: -20px;
color: #7a7a7a;
}
[dir="ltr"] .md-typeset blockquote p:last-child {
color: #999999;
font-size: 14px;
display: block;
margin-top: 5px;
}

View File

@ -5,8 +5,17 @@ site_description: Django REST framework - Web APIs for Django
repo_url: https://github.com/encode/django-rest-framework
theme:
name: mkdocs
custom_dir: docs_theme
name: material
favicon: theme/img/favicon.ico
logo: ""
palette:
primary: custom
accent: custom
features:
- content.code.copy
extra_css:
- theme/stylesheets/extra.css
markdown_extensions:
- admonition

View File

@ -1,5 +1,5 @@
# MkDocs to build our documentation.
mkdocs==1.6.0
mkdocs-material[imaging]==9.7.0
# pylinkvalidator to check for broken links in documentation.
pylinkvalidator==0.3