FastAPI-Cap/mkdocs.yml at main · devbijay/FastAPI-Cap · 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
site_name: FastAPI Cap
repo_url: https://github.com/devbijay/FastAPI-Cap
edit_uri: edit/main/docs/
repo_name: FastAPI Cap
site_url: https://devbijay.github.io/FastAPI-Cap


extra_css:
  - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css

theme:
  name: material
  icon:
    repo: fontawesome/brands/github
  language: en

  features:
    - navigation.instant
    - navigation.path
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.tracking
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.code.select
    - content.tabs.link
    - content.action.edit
    - content.action.view
    - content.footnote.tooltips
    - toc.follow

  font:
    text: Roboto

  palette:
    - scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

plugins:
  - search:
      lang: en
      separator: '[\s\-\.]+'
      pipeline:
        - stemmer
        - stopWordFilter
  - mkdocstrings:
      handlers:
        python:
          options:
            merge_init_into_class: true
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            separate_signature: true
            unwrap_annotated: true
            members_order: source
            docstring_style: google
            show_source: true
            show_signature: true
            show_root_heading: true
            show_inheritance_diagram: true
            extra:
              follow_wrapped: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra_javascript:
- https://unpkg.com/mermaid@10.9.0/dist/mermaid.min.js

nav:
  - Home: index.md
  - Quick Start: quickstart.md
  - Advance Guide: advanced.md
  - Strategies:
      - Overview: strategies/overview.md
      - Fixed Window: strategies/fixed_window.md
      - Sliding Window: strategies/sliding_window.md
      - Sliding Window (Log Based): strategies/sliding_window_log.md
      - Token Bucket: strategies/token_bucket.md
      - Leaky Bucket: strategies/leaky_bucket.md
      - GCRA Rate Limiting: strategies/gcra.md
  - API Reference: api.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devbijay/FastAPI-Cap
      name: GitHub
  announcement:
    type: info
    text: "⭐️ Star FastAPI-Cap on [GitHub](https://github.com/devbijay/FastAPI-Cap)!"