dash_dashkit/mkdocs.yml at main · iamgp/dash_dashkit · 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
site_name: Dashkit Documentation
site_description: Modern dashboard components for Dash applications
site_url: https://your-domain.com/
repo_url: https://github.com/iamgp/dash_dashkit
repo_name: iamgp/dash_dashkit

# Build directories
docs_dir: docs
site_dir: site

# Theme configuration
theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      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.suggest
    - search.highlight
    - search.share
    - header.autohide
    - content.tabs.link
    - content.code.copy
    - content.code.select
    - content.tooltips

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye

  font:
    text: Inter
    code: JetBrains Mono

# Plugins
plugins:
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_root_heading: true
            show_source: false
            heading_level: 2
  - minify:
      minify_html: true
  - git-revision-date-localized:
      enable_creation_date: true

# Extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - admonition
  - attr_list
  - md_in_html
  - footnotes
  - tables
  - toc:
      permalink: true
      title: On this page

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: guides/quickstart.md
  - API Reference:
    - Overview: api/README.md
    - Setup: api/setup.md
    - Components:
      - Layout: api/components/layout.md
      - Sidebar: api/components/sidebar.md
      - Header: api/components/header.md
      - Table: api/components/table.md
      - Buttons: api/components/buttons.md
      - Cards: api/components/cards.md
      - Markdown Report: api/components/markdown.md
      - Charts: api/components/charts.md
  - Internals:
    - Architecture: internals/architecture.md
    - Development: internals/development.md

# Extra CSS and JavaScript
extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

# Footer and social links
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/iamgp/dash_dashkit
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/dash-dashkit/
  generator: false

# Copyright
copyright: Copyright &copy; 2024 Dashkit Team