databeak/mkdocs.yml at main · jonpspri/databeak · 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
---
site_name: DataBeak
site_description: AI-Powered CSV Processing via Model Context Protocol
site_author: Jonathan Springer
site_url: https://jonpspri.github.io/databeak/

# Repository
repo_name: jonpspri/databeak
repo_url: https://github.com/jonpspri/databeak
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright &copy; 2025 DataBeak

# Configuration
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
    - content.code.copy
    - content.action.edit
  font:
    text: Roboto
    code: Roboto Mono
  favicon: img/favicon.ico
  logo: img/logo.svg

# Navigation
nav:
  - Home: index.md
  - Installation: installation.md
  - Tutorials:
      - Quick Start: tutorials/quickstart.md
  - API Reference:
      - Overview: api/index.md
  - Architecture: architecture.md
  - Version Management: version-management.md

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: jonpspri
      repo: databeak
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Plugins
plugins:
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_source: true
            show_root_heading: true
            show_object_full_path: false
            show_category_heading: true

# Extra
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jonpspri/databeak
      name: GitHub Repository
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/databeak
      name: PyPI Package
    - icon: fontawesome/solid/comment-dots
      link: https://github.com/jonpspri/databeak/discussions
      name: GitHub Discussions

# Custom CSS
extra_css:
  - stylesheets/extra.css

# Watch additional files for changes during development
watch:
  - src/databeak/