hyper-admin/mkdocs.yml at develop · yevheniidehtiar/hyper-admin · 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
site_name: HyperAdmin
site_description: A modern, Pydantic-native admin interface for FastAPI, powered by HTMX.
site_url: https://yevheniidehtiar.github.io/hyper-admin/

theme:
  name: "material"
  palette:
    primary: white
  features:
    - navigation.tabs
    - content.code.copy
  logo: assets/logo.svg
  favicon: assets/favicon.ico

repo_name: yevheniidehtiar/hyper-admin
repo_url: https://github.com/yevheniidehtiar/hyper-admin
edit_uri: ""

nav:
  - Introduction: "index.md"
  - Getting Started: "getting-started.md"
  - Tutorial: "tutorial.md"
  - Examples: "examples.md"
  - Frontend:
      - Overview: "frontend/overview.md"
      - Widgets: "frontend/widgets.md"
      - HTMX Patterns: "frontend/htmx_patterns.md"
  - API Reference:
      - Application: "api/application.md"
      - Views: "api/views.md"
      - Core Components: "api/core.md"
      - Adapters: "api/adapters.md"
      - Routing: "api/routing.md"

markdown_extensions:
  - markdown.extensions.codehilite:
      guess_lang: false
  - admonition
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.tabbed
  - pymdownx.superfences

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: true
            show_source: false

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yevheniidehtiar
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/yevheniidehtiar/