guard-agent/mkdocs.yml at master · Guard-Core/guard-agent · 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
149
150
151
152
153
154
155
site_name: Guard Agent
site_description: Framework-agnostic telemetry and monitoring agent for the Guard security ecosystem (fastapi-guard, flaskapi-guard, djangoapi-guard, tornadoapi-guard).
site_url: https://guard-core.github.io/guard-agent/
repo_name: Guard-Core/guard-agent
repo_url: https://github.com/Guard-Core/guard-agent
edit_uri: edit/master/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: dark-blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: dark-blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: assets/guard_core_logo.svg
  favicon: assets/guard_core_favicon.png

nav:
  - Home: index.md
  - Installation: installation.md
  - Adapters:
    - FastAPI: adapters/fastapi.md
    - Flask: adapters/flask.md
    - Django: adapters/django.md
    - Tornado: adapters/tornado.md
  - Tutorial:
    - Getting Started: tutorial/getting-started.md
  - API Reference:
    - Overview: api/overview.md
  - Release Notes: release-notes.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [guard_agent]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google
            show_if_no_docstring: true
            filters: ["!^_"]
            merge_init_into_class: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Guard-Core/guard-agent
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/guard-agent/
      name: PyPI
    - icon: material/web
      link: https://guard-core.com
      name: guard-core.com
    - icon: material/view-dashboard
      link: https://app.guard-core.com
      name: Dashboard (app.guard-core.com)
    - icon: material/flask
      link: https://playground.guard-core.com
      name: Playground (playground.guard-core.com)
    - icon: fontawesome/brands/discord
      link: https://discord.gg/ZW7ZJbjMkK
      name: Discord

  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve by using our
            <a href="https://github.com/Guard-Core/guard-agent/issues/new">issue tracker</a>.

  generator: false
  meta:
    - property: og:type
      content: website
    - property: og:title
      content: Guard Agent - Framework-Agnostic Security Telemetry for Python Web Apps
    - property: og:description
      content: Framework-agnostic telemetry and monitoring agent for the Guard security ecosystem (fastapi-guard, flaskapi-guard, djangoapi-guard, tornadoapi-guard).
    - property: og:image
      content: https://guard-core.github.io/guard-agent/assets/guard_agent_legend.svg
    - name: keywords
      content: fastapi, flask, django, tornado, security, middleware, python, telemetry, monitoring, ip control, rate limiting, penetration detection

  version:
    provider: mike
    default: latest
    version_selector: true
    json_file: /guard-agent/versions.json

  author:
    name: Renzo Franceschini
    url: https://github.com/rennf93

copyright: Guard Agent by

extra_css:
  - css/custom.css