hyperflask-docs/mkdocs.yml at main · hyperflask/hyperflask-docs · 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
137
138
139
140
141
142
143
144
145
146
147
148
site_name: Hyperflask
site_url: https://hyperflask.dev
repo_url: https://github.com/hyperflask/hyperflask
repo_name: hyperflask/hyperflask
edit_uri: https://github.com/hyperflask/hyperflask-docs/edit/main/docs/
copyright: Docs licensed under CC BY-SA 4.0

nav:
  - Home: index.md
  - why.md
  - getting-started.md
  - Guides:
    - guides/setup.md
    - Basics:
       - guides/structure.md
       - guides/config.md
       - guides/pages.md
       - guides/components.md
       - guides/interactive-apps.md
       - guides/static.md
       - guides/assets.md
    - Handling data:
       - guides/forms.md
       - guides/models.md
       - guides/files.md
       - guides/suspense.md
    - Digging deeper:
       - guides/flash.md
       - guides/metadata.md
       - guides/emails.md
       - guides/tasks.md
       - guides/i18n.md
       - guides/push.md
       - guides/security.md
       - guides/errors.md
    - Deploy to production:
       - guides/deploy.md
       - guides/scaling.md
    - guides/users.md
    - guides/for-flask-users.md
  - Components:
    - components/index.md
    - components/icons.md
    - components/forms.md
    - components/modals.md
    - components/layout.md
    - components/daisyui/index.md
  - Recipes:
    - recipes/going-to-production.md
    - recipes/hosting.md
    - recipes/sending-emails.md
    - recipes/monitoring.md
    - recipes/analytics.md
    - recipes/stripe.md
    - recipes/using-cms.md
  - "Status & Roadmap": roadmap.md
  - Blog:
    - blog/index.md
  - Discussions: https://github.com/hyperflask/hyperflask/discussions

theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      primary: white
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.path
    - navigation.top
    - navigation.footer
    - content.action.edit
    - content.code.copy
  icon:
    edit: material/pencil
  favicon: assets/favicon.png

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - search
  - callouts
  - blog
  - redirects:
      redirect_maps:
        'guides/index.md': 'guides/setup.md'
  - llmstxt-md:
      enable_copy_button: false
      sections:
        Guides:
        - guides/setup.md
        - guides/structure.md
        - guides/config.md
        - guides/pages.md
        - guides/components.md
        - guides/interactive-apps.md
        - guides/static.md
        - guides/assets.md
        - guides/forms.md
        - guides/models.md
        - guides/files.md
        - guides/suspense.md
        - guides/flash.md
        - guides/metadata.md
        - guides/emails.md
        - guides/tasks.md
        - guides/i18n.md
        - guides/push.md
        - guides/security.md
        - guides/errors.md
        - guides/deploy.md
        - guides/scaling.md
        - guides/users.md
        Components:
        - components/index.md
        - components/icons.md
        - components/forms.md
        - components/modals.md
        - components/layout.md
        - components/daisyui/index.md


extra_css:
  - assets/stylesheets/extra.css