proxy-pattern-pool/mkdocs.yml at main · zx80/proxy-pattern-pool · 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
site_name: ProxyPatternPool Python Package
site_url: https://zx80.github.io/proxy-pattern-pool/
repo_url: https://github.com/zx80/proxy-pattern-pool
site_dir: _site
copyright: 2022-2025 Fabien Coelho

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking  # update url bar
    - navigation.top
    - navigation.footer
    # - navigation.instant.progress
    # - navigation.sections
    # - navigation.path
    # - navigation.expand
    # - content.code.copy
    - search.suggest
    - search.highlight
    - toc.follow
    # - toc.integrate  # vs separated TOC
    # - search.share
    - header.autohide
  logo: proxy-pattern-pool-dalle-logo.webp
  favicon: favicon.ico
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: orange
      accent: orange
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: deep-orange
      accent: deep-orange
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - search
  # - glightbox  # image pop-up
  - mkdocstrings

extra:
  generator: false  # drop footer notice about mkdocs material

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - attr_list  # images
  - md_in_html  # images
  - pymdownx.arithmatex:
      generic: true
#  - markdown_include.include:
#     # {!filename!}
#     # {!filename!lines=1 5-10}
#     base_path: docs

nav:
  - Index: index.md
  - Discussion: DISCUSSION.md
  - API: REFERENCE.md
  - Versions: VERSIONS.md
  - Backlog: TODO.md