flask-restapi/mkdocs.yml at main · jonarsli/flask-restapi · 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
site_name: Flask-RESTAPI
repo_url: https://github.com/JonarsLi/flask-restapi
repo_name: JonarsLi/flask-restapi
nav:
  - Overview: index.md
  - Install: install.md
  - Quickstart: quickstart.md
  - Decorators:
    - Path: decorators/path.md
    - Query: decorators/query.md
    - Header: decorators/header.md
    - Body: decorators/body.md
    - Form: decorators/form.md
    - Auth: decorators/auth.md
    - Response: decorators/response.md
    - Blueprint Map: decorators/bp_map.md
  - Response: response.md
  - Tag: tag.md
  - Upload files: files.md
  - OpenAPI: openapi.md
  - Function Based View: function_based_view.md
  - API Reference:
    - Core: api/core.md
    - Exceptions: api/exceptions.md
theme:
  name: "material"
  logo: assets/logo.png
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github
plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: true
            show_source: true
      watch:
        - flask_restapi

markdown_extensions:
  - pymdownx.tabbed
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.critic
  - pymdownx.details
  - admonition
  - def_list
  - toc:
      permalink: true