Skip to content

Commit

Permalink
mkdocs: Add Theme and more pages
Browse files Browse the repository at this point in the history
Signed-off-by: Rong Tao <rongtao@cestc.cn>
  • Loading branch information
Rtoax committed Feb 27, 2024
1 parent 6adde08 commit a016de3
Showing 1 changed file with 110 additions and 0 deletions.
110 changes: 110 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,114 @@ copyright: Copyright &copy; 2021 - 2024 Rong Tao

nav:
- Home: index.md
- Tutorials:
- Code Style: code-style.md
- Developer: developers.md

theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: black
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
toggle:
icon: material/weather-night
name: Switch to light mode
features:
# - navigation.instant # see https://github.com/ultrabug/mkdocs-static-i18n/issues/62
- navigation.tracking
- navigation.tabs
- navigation.sections
- navigation.indexes
- navigation.top
- navigation.footer
- toc.follow
- search.highlight
- search.share
- search.suggest
- content.action.view
- content.action.edit
- content.tabs.link
- content.code.copy
- content.code.select
- content.code.annotations

markdown_extensions:
# Officially Supported Extensions
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- meta
- sane_lists
- tables
- toc:
permalink: true
- wikilinks
# Third Party Extensions(Bundles, PyMdown Extensions)
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde

plugins:
- search
- include-markdown
- mkdocstrings:
default_handler: python
handlers:
python:
options:
# Headings
show_root_heading: true
show_root_toc_entry: true
show_object_full_path: true
# Members
show_submodules: false
# Docstrings
docstring_section_style: spacy
- i18n:
docs_structure: folder
fallback_to_default: true
languages:
- locale: en
default: true
name: English
- locale: zh
default: false
name: 中文
nav_translations:
Home: 主页
Tutorials: 教程
Code Style: 代码风格
Developer: 开发者

extra:
generator: false
social:
- icon: fontawesome/solid/paper-plane
link: mailto:rtoax@foxmail.com
- icon: fontawesome/brands/github
link: https://github.com/Rtoax/ulpatch

0 comments on commit a016de3

Please sign in to comment.