svglab/mkdocs.yml at main · reznakt/svglab · 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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
site_name: SVGLAB Documentation
site_description: A manipulation and optimization library for Scalable Vector Graphics
site_author: Tomáš Režňák
site_url: https://svglab.rocks/

copyright: Copyright &copy 2024 Tomáš Režňák

repo_url: https://github.com/reznakt/svglab
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - API Reference:
      - Elements: api-reference/elements.md
      - Attributes: api-reference/attributes.md
      - Attribute Groups: api-reference/attribute-groups.md
      - Traits: api-reference/traits.md

theme:
  name: material
  language: en
  logo: &logo assets/logo.svg
  favicon: *logo
  custom_dir: docs/overrides

  icon:
    repo: fontawesome/brands/github

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default

      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - toc.integrate

plugins:
  - optimize
  - privacy
  - search
  - social

  - redirects:
      redirect_maps:
        getting-started.md: getting-started/installation.md

  - git-revision-date-localized:
      enable_creation_date: true

  - git-committers:
      repository: reznakt/svglab
      branch: main

  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true

  - mkdocstrings:
      enabled: !ENV [CI, false]
      handlers:
        python:
          options:
            extensions:
              - griffe_fieldz:
                  include_inherited: true
            allow_inspection: true
            show_bases: true
            docstring_style: google
            docstring_section_style: list
            show_if_no_docstring: true
            show_submodules: true
            show_signature_annotations: true
            separate_signature: true
            signature_crossrefs: true
            unwrap_annotated: true

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.betterem
  - pymdownx.blocks.caption
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.tilde
  - tables
  - pymdownx.magiclink:
      repo_url_shortener: true
      repo_url_shorthand: true
      user: reznakt
      repo: svglab
      normalize_issue_symbols: true
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - js/keybinds.js
  - js/mathjax.js

extra_css:
  - css/mathjax.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/reznakt/svglab
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/svglab/