brag-ai/mkdocs.yml at main · ruancomelli/brag-ai · 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
strict: true
site_name: Brag AI
site_description: Generate and maintain a brag document automatically from your GitHub contributions, powered by AI.
site_url: https://www.ruancomelli.com/brag-ai
docs_dir: docs
site_dir: site
dev_addr: 127.0.0.1:8000
repo_url: https://github.com/ruancomelli/brag-ai
edit_uri: edit/main/docs

nav:
- Welcome: index.md
- Installation: installation.md
- Usage: usage.md
- Configuration: configuration.md
- External links:
  - GitHub 🔗: https://github.com/ruancomelli/brag-ai
  - PyPI 🔗: https://pypi.org/project/brag-ai/

plugins:
- search
- social
- api-autonav:
    modules: [src]
- mkdocstrings:
    handlers:
      python:
        inventories:
        - https://docs.python.org/3/objects.inv
        options:
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: table
          extensions:
          - dataclasses
          filters: ['!^_']
          parameter_headings: true
          separate_signature: true
          show_signature_annotations: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true

theme:
  name: material
  logo: assets/icon.svg
  favicon: assets/favicon.svg
  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)'
    scheme: default
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode

  # Palette toggle for dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to system preference
  icon:
    annotation: material/arrow-right-circle
    repo: fontawesome/brands/github
  features:
  - navigation.expand
  - navigation.footer
  - navigation.sections
  - navigation.tracking
  - content.action.edit
  - content.action.view
  - content.code.copy
  - content.code.annotate

markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.magiclink:
    repo_url_shorthand: true
    normalize_issue_symbols: true
    provider: github
    user: ruancomelli
    repo: brag-ai
- pymdownx.snippets:
    base_path:
    - docs/snippets
    check_paths: true
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
- md_in_html
- attr_list
- toc:
    permalink: 🔗
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

extra_css:
- css/extra.css

extra:
  social:
  - icon: fontawesome/brands/github
    link: https://github.com/ruancomelli/brag-ai
    name: ruancomelli/brag-ai on GitHub

copyright: '&copy; 2025 Ruan Comelli'