From 30ae1e452f670e0b07540805b301ca0dc4125834 Mon Sep 17 00:00:00 2001 From: Paolo Melchiorre Date: Sun, 12 Nov 2023 18:16:20 +0100 Subject: [PATCH] Fix # 1412 -- Use Material for MkDocs --- docs/python.svg | 1 + mkdocs.yml | 36 ++++++++++++++++++++++++++++++++++-- pyproject.toml | 2 +- 3 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 docs/python.svg diff --git a/docs/python.svg b/docs/python.svg new file mode 100644 index 00000000..e6ffbf0a --- /dev/null +++ b/docs/python.svg @@ -0,0 +1 @@ + diff --git a/mkdocs.yml b/mkdocs.yml index fd2e407c..b21792f3 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,10 +8,42 @@ use_directory_urls: true watch: [markdown, scripts] theme: - name: nature - icon: py.png + name: material + icon: + previous: fontawesome/solid/angle-left + next: fontawesome/solid/angle-right + logo: python.svg + favicon: favicon.ico release: !!python/name:markdown.__version__ + repo_url: https://github.com/Python-Markdown/markdown + repo_name: Python-Markdown/markdown issue_tracker: https://github.com/Python-Markdown/markdown/issues + icon: + repo: fontawesome/brands/git-alt + features: + - navigation.footer + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: green + toggle: + icon: material/weather-night + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: green + toggle: + icon: material/weather-sunny + name: Switch to light mode + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/Python-Markdown/markdown + name: GitHub + - icon: fontawesome/brands/python + link: https://pypi.org/project/Markdown/ + name: PyPI extra_css: - custom.css diff --git a/pyproject.toml b/pyproject.toml index 8c9e9bcf..5d83c97a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,7 +54,7 @@ testing = [ ] docs = [ 'mkdocs>=1.5', - 'mkdocs-nature>=0.6', + 'mkdocs-material>=9.0', 'mdx_gh_links>=0.2', "mkdocstrings[python]", "mkdocs-gen-files",