chemigram/mkdocs.yml at main · chipi/chemigram · 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
site_name: Chemigram
site_description: Agent-driven photo editing on darktable, via MCP — design and engineering documentation.
site_url: https://chipi.github.io/chemigram/
repo_url: https://github.com/chipi/chemigram
repo_name: chipi/chemigram
edit_uri: edit/main/docs/
copyright: MIT — Marko Mrdjenovic and contributors
docs_dir: docs

# Internal / historical surfaces — not for the public site.
exclude_docs: |
  briefs/
  agent-prompt.md
  PRD_TEMPLATE.md
  RFC_TEMPLATE.md
  ADR_TEMPLATE.md
  prd/PRD_TEMPLATE.md
  rfc/RFC_TEMPLATE.md
  adr/ADR_TEMPLATE.md

theme:
  name: material
  language: en
  features:
    # Navigation: single sidebar on the left. Top-level entries are
    # clickable expandable folders (no static section labels). Each
    # section has its own index.md as the landing page (clicked label
    # opens that index). TOC stays on the right via toc.follow.
    - navigation.indexes         # index.md becomes the section's clickable landing
    - navigation.tracking        # update URL hash as the reader scrolls
    - navigation.top             # back-to-top button
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - awesome-pages
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            docstring_style: google
            separate_signature: true
            line_length: 88
            merge_init_into_class: true
            heading_level: 2
            show_if_no_docstring: false
            filters: ["!^_[^_]"]  # hide single-underscore privates by default

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/chipi/chemigram
  status:
    new: Recently added
    deprecated: Deprecated
  generator: false  # drop the "Made with Material for MkDocs" footer line

# Don't fail the build on missing nav entries (we don't list every
# template/historical file in nav; awesome-pages handles auto-discovery
# within sections). DO fail on broken links — those should always be fixed.
strict: false