Sentinel/mkdocs.yml at main · sidxz/Sentinel · 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
site_name: Sentinel Auth
site_description: Authentication, workspace management, and permissions microservice
site_url: https://github.com/sidxz/Sentinel

repo_name: sentinel
repo_url: https://github.com/sidxz/Sentinel

theme:
  name: material
  logo: assets/images/logo.png
  favicon: assets/images/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: red
      accent: red
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

extra_css:
  - assets/css/extra.css

plugins:
  - search
  - section-index
  - glightbox

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.mark
  - pymdownx.tasklist:
      custom_checkbox: true
  - tables
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Quickstart: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - Guide:
    - How It Works: guide/how-it-works.md
    - Authentication: guide/authentication.md
    - Authorization: guide/authorization.md
    - Workspaces: guide/workspaces.md
    - Groups: guide/groups.md
    - Roles (RBAC): guide/roles.md
    - Permissions (ACLs): guide/permissions.md
    - Service Apps: guide/service-apps.md
    - Admin Panel: guide/admin-panel.md
  - Tutorials:
    - React + FastAPI: tutorial/react.md
    - Next.js: tutorial/nextjs.md
    - Proxy Mode: tutorial/proxy-mode.md
  - Python SDK:
    - sdk/index.md
    - Sentinel Class: sdk/sentinel-class.md
    - Middleware: sdk/middleware.md
    - Dependencies: sdk/dependencies.md
    - Permissions: sdk/permissions.md
    - Roles: sdk/roles.md
    - DDD / Clean Architecture: sdk/ddd.md
  - JS/TS SDK:
    - js-sdk/index.md
    - AuthZ Client: js-sdk/authz-client.md
    - React: js-sdk/react.md
    - Next.js: js-sdk/nextjs.md
    - Server Utilities: js-sdk/server.md
    - Proxy Client: js-sdk/proxy-client.md
  - API Reference:
    - api/index.md
    - Authentication: api/auth.md
    - Resources: api/resources.md
    - Permissions: api/permissions.md
    - Roles: api/roles.md
    - Schemas: api/schemas.md
  - Security: security.md
  - Deployment:
    - deployment/index.md
    - Environment Variables: deployment/environment.md
  - Contributing:
    - contributing/index.md
    - Database: contributing/database.md
    - Testing: contributing/testing.md