map_with_stats/mkdocs.yml at main · mlisovyi/map_with_stats · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
site_name: "Map with statistics"
# the git repo link in the header
repo_url: https://github.com/mlisovyi/map_with_stats
# the title to use for the git repo link
repo_name: "map_with_stats"
# relative path to the markdown files on github
edit_uri: blob/main/docs/

nav:
  - Introduction: "index.md"
  - Quick start guide: "quick_start.md"
  - FAQ: "faq.md"
  - API: "api.md"

theme:
  name: material
  # this parameter defines where to find HTML that will overwrite or complement the pages from the theme
  custom_dir: overrides
  features:
    # enables annotations, see https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#code-annotations
    - content.code.annotate
    # for navigation features see https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
    - navigation.top
    - navigation.tracking
    # keep all sections in the navigation expanded by default
    - navigation.expand
    # add icon and link to the document on gihub for each page
    - content.action.edit
    # add highlighting of search words
    - search.highlight
    # add autocomplete to the search bar
    - search.suggest
  icon:
    logo: fontawesome/solid/map
    # icon for the git repository link on the top-right
    repo: fontawesome/brands/github
    # icon for the view of the current page in the repository
    edit: material/eye
  favicon: assets/favicon-32x32.png
  palette:
    # light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      # main theme color
      primary: deep orange
      # the color to change to for a hover on an interactive element
      accent: amber
      # definition of the  header icon for this mode
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      # main theme color
      primary: deep orange
      # the color to change to for a hover on an interactive element
      accent: amber
      # definition of the  header icon for this mode
      toggle:
        icon: material/weather-night
        name: Switch to light mode

# use a long list of recommended extensions from https://squidfunk.github.io/mkdocs-material/setup/extensions/?h=pymdownx#recommended-configuration
markdown_extensions:
  # Python Markdown
  - admonition
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tilde

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          # where to look for python modules. not strictly required, but helps, if building from an arbitrary folder
          # paths: [src]
          options:
            docstring_style: google
            show_if_no_docstring: True
            show_root_toc_entry: False

# auto-reload on changes in the following folders outside of the docs (for development of docs)
watch:
  - src

# add analytics
extra:
  analytics:
    provider: custom