FuncToWeb/mkdocs.yml at main · offerrall/FuncToWeb · 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
site_name: FuncToWeb
site_description: Transform any Python function into a complete web app automatically. Just type hints and run()
site_author: Beltrán Offerrall
repo_name: FuncToWeb
repo_url: https://github.com/offerrall/FuncToWeb


theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - toc.integrate
    - navigation.tabs.sticky
    - navigation.top
    - hide:
        - toc.title
  palette:

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Dark mode

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: '__span'
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences

nav:
  - Home: index.md
  - Input Types:
      - Basic Types: types.md
      - File Types: files.md
      - Lists: lists.md
      - Optional Parameters: optional.md
      - Dropdowns: dropdowns.md
  - Types Constraints: constraints.md
  - Output Types:
      - Images & Plots: images.md
      - File Downloads: downloads.md
      - Tables: tables.md
      - Multiple Outputs: multiple-outputs.md
  - Other Features:
      - Function Descriptions: function-descriptions.md
      - Multiple Functions: multiple.md
      - Authentication: authentication.md
      - Dark Mode: dark-mode.md
      - Server Configuration: server-configuration.md
  - API: api.md

plugins:
  - minify:
      minify_html: true
plugins:
  - minify:
      minify_html: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/offerrall/FuncToWeb
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/offerrall