auth-engine-docs/mkdocs.yml at main · auth-engine/auth-engine-docs · 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
site_name: AuthEngine
site_author: Niranjan Kumar

exclude_docs: |
  README.md
site_description: AuthEngine platform documentation — deployment, architecture, API, and security
site_url: https://docs.authengine.org
repo_url: https://github.com/auth-engine/auth-engine-docs
repo_name: auth-engine-docs
edit_uri: edit/main/docs/

copyright: >
  &copy; 2026
  <a href="https://github.com/auth-engine" target="_blank" rel="noopener">AuthEngine</a>
  · Niranjan Kumar

theme:
  name: material
  custom_dir: overrides
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search

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
  - tables
  - toc:
      permalink: true

# Mandatory navigation — every page must be listed here (no auto-discovery)
nav:
  - Home: index.md
  - Getting started:
      - Quick Start: quick-start.md
      - Deployment: deployment.md
  - Platform:
      - Architecture: architecture.md
      - Security: security-overview.md
  - Integration:
      - API Reference: api-reference.md
      - OAuth2 / OIDC: oauth2-oidc-guides.md
  - Community:
      - Contributing: contributing.md
      - Security Policy: security-policy.md
  - About:
      - About: about-author.md

extra_css:
  - stylesheets/extra.css

extra:
  generator: false