fastauth/mkdocs.yml at main · sreekarnv/fastauth · 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
site_name: FastAuth
site_description: NextAuth-inspired pluggable authentication for FastAPI
site_url: https://sreekarnv.github.io/fastauth
repo_url: https://github.com/sreekarnv/fastauth
repo_name: sreekarnv/fastauth
copyright: Copyright &copy; 2026 Sreekar Nutulapati

theme:
  name: material
  palette:
    scheme: slate
    primary: black
    accent: cyan
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

extra_css:
  - css/extra.css

plugins:
  - search
  - gen-files:
      scripts:
        - scripts/gen_api_docs.py
  - mkdocstrings:
      handlers:
        python:
          paths: [packages/fastauth/src]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true

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

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quick-start.md
      - Configuration: getting-started/configuration.md
  - Concepts:
      - How it Works: concepts/how-it-works.md
      - Providers: concepts/providers.md
      - Adapters: concepts/adapters.md
      - Tokens & Sessions: concepts/tokens.md
  - Providers:
      - Credentials: providers/credentials.md
      - Magic Links: providers/magic-links.md
      - Google OAuth: providers/google.md
      - GitHub OAuth: providers/github.md
  - Adapters:
      - SQLAlchemy: adapters/sqlalchemy.md
      - Memory: adapters/memory.md
      - Custom Adapter: adapters/custom.md
  - Features:
      - Cookie Delivery: features/cookies.md
      - Email Verification: features/email-verification.md
      - Password Reset: features/password-reset.md
      - Account Management: features/account.md
      - OAuth Flow: features/oauth.md
      - Passkeys (WebAuthn): features/passkeys.md
      - Magic Links: features/magic-links.md
      - RBAC: features/rbac.md
      - JWT: features/jwt.md
      - Event Hooks: features/hooks.md
  - Guides:
      - Basic App: guides/basic.md
      - Adding OAuth: guides/oauth.md
      - Passkeys: guides/passkeys.md
      - Magic Links: guides/magic-links.md
      - Microservice JWT: guides/microservice.md
      - Testing: guides/testing.md
      - Production Checklist: guides/production.md
  - Troubleshooting: troubleshooting.md
  - Reference:
      - FastAuth: reference/fastauth.md
      - Configuration: reference/config.md
      - Exceptions: reference/exceptions.md
      - Types: reference/types.md
      - Protocols: reference/protocols.md
      - Dependencies: reference/deps.md
      - Adapters: reference/adapters.md
      - Providers: reference/providers.md
      - Session Backends: reference/session-backends.md
      - Email Transports: reference/email-transports.md
  - CLI: cli.md