fastapi-admin-kit/mkdocs.yml at main · borhanst/fastapi-admin-kit · 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
site_name: FastAPI Admin Kit
site_description: Drop-in admin panel for FastAPI + SQLAlchemy apps
site_url: https://borhanst.github.io/fastapi-admin-kit/
repo_url: https://github.com/borhanst/fastapi-admin-kit
repo_name: fastapi-admin-kit

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - search.suggest
    - search.highlight
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_root_heading: true
            members_order: source

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Configuration: getting-started/configuration.md
  - Guide:
      - All Features: guide/features.md
      - Model Registration: guide/model-registration.md
      - Authentication & RBAC: guide/auth-rbac.md
      - Widgets & Forms: guide/widgets-forms.md
      - Themes & UI: guide/themes.md
      - Inline Editing & Actions: guide/inline-editing-actions.md
      - Filters: guide/filters.md
      - Dashboard: guide/dashboard.md
      - Navigation & Sidebar: guide/navigation.md
      - Audit Logging: guide/audit-logging.md
      - Storage & File Uploads: guide/storage.md
      - JSON API: guide/json-api.md
      - CLI Tools: guide/cli.md
      - Command Palette: guide/command-palette.md
      - Pagination: guide/pagination.md
      - Alembic Setup: guide/alembic-setup.md
  - API Reference:
      - Admin: api/admin.md
      - Widgets: api/widgets.md
      - Auth: api/auth.md
  - Contributing: contributing.md
  - Upcoming Features: upcoming-features.md