pyron/mkdocs.yml at main · NezbiT/pyron · 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
site_name: Pyron
site_description: Hybrid Python web framework — FastAPI to write, Django to operate, Rust on the hot path.
site_url: https://nezbit.github.io/pyron/
repo_url: https://github.com/NezbiT/pyron
repo_name: NezbiT/pyron
edit_uri: edit/main/docs/
copyright: MIT · Pyron
docs_dir: docs
site_dir: site
dev_addr: 127.0.0.1:8001

theme:
  name: material
  custom_dir: overrides
  language: en
  font:
    text: IBM Plex Sans
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Follow the system
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Light
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Dark
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.instant
    - navigation.tracking
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  icon:
    logo: material/fire
    repo: fontawesome/brands/github

plugins:
  - search:
      lang: en

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/NezbiT/pyron
      name: Source

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      check_paths: true
      base_path:
        - .
        - docs
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Start:
      - Install: install.md
      - Quickstart: quickstart.md
      - Enable later: enable.md
  - Build:
      - API: api.md
      - Admin panel: admin.md
      - Auth: auth.md
      - Data (SQL, Mongo, Redis): data.md
      - CLI: cli.md
      - Security: security.md
  - Understand:
      - Architecture: architecture.md
      - Comparison: comparison.md
      - Changelog: changelog.md
      - Contributing: contributing.md