Skip to content

Commit

Permalink
Use Material for MkDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
pauloxnet committed Nov 10, 2023
1 parent bc14d59 commit cdf0ca9
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/python.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 34 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit cdf0ca9

Please sign in to comment.