frappeapi/mkdocs.yml at main · 0xsirsaif/frappeapi · 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
site_name: FrappeAPI
site_url: https://0xsirsaif.github.io/frappe-api/
site_author: Muhammad Saif
site_description: "FrappeAPI brings FastAPI-style routing, validation, and automatic OpenAPI documentation to the Frappe Framework. Build modern REST APIs for Frappe with Python type hints."
repo_name: 0xsirsaif/frappe-api
repo_url: https://github.com/0xsirsaif/frappe-api
edit_uri: https://github.com/0xsirsaif/frappe-api/tree/main/docs

plugins:
  - search
  - social:
      enabled: !ENV [CI, false]

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/0xsirsaif/frappe-api
    - icon: fontawesome/brands/twitter
      link: https://x.com/0xsaif_

theme:
  name: material
  custom_dir: docs/overrides
  language: en
  favicon: img/favicon.png
  logo: img/icon-white.svg
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - toc.integrate
    - content.code.copy
  palette:
    # Palette for light mode
    - scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode


nav:
  - Introduction: index.md
  - Usage Examples: usage_examples.md
  - OpenAPI Docs: openapi_docs.md
  - Roadmap: roadmap.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      anchor_linenums: true
  - toc:
      permalink: true
  - pymdownx.tasklist:
      custom_checkbox: true