Files
fastapi-users/mkdocs.yml

101 lines
2.8 KiB
YAML

site_name: FastAPI Users
site_description: Ready-to-use and customizable users management for FastAPI
theme:
name: 'material'
palette:
- scheme: default
primary: 'red'
accent: 'red'
toggle:
icon: material/lightbulb
name: Switch to dark mode
- scheme: slate
primary: 'red'
accent: 'red'
toggle:
icon: material/lightbulb-outline
name: Switch to light mode
icon:
logo: material/account-supervisor
favicon: 'favicon.png'
repo_name: frankie567/fastapi-users
repo_url: https://github.com/fastapi-users/fastapi-users
edit_uri: ""
markdown_extensions:
- toc:
permalink: true
- admonition
- codehilite
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid
- pymdownx.tasklist
- pymdownx.tabbed:
alternate_style: true
- pymdownx.snippets
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
plugins:
- search
- mermaid2:
arguments:
theme: |
^(JSON.parse(window.localStorage.getItem('/.__palette')).index == 1) ? 'dark' : 'light'
extra_javascript:
- https://unpkg.com/mermaid/dist/mermaid.min.js
nav:
- About: index.md
- installation.md
- Configuration:
- configuration/overview.md
- configuration/models.md
- Database adapters:
- configuration/databases/sqlalchemy.md
- configuration/databases/mongodb.md
- configuration/databases/tortoise.md
- configuration/databases/ormar.md
- Authentication backends:
- Introduction: configuration/authentication/index.md
- Transports:
- configuration/authentication/transports/cookie.md
- configuration/authentication/transports/bearer.md
- Strategies:
- configuration/authentication/strategies/database.md
- configuration/authentication/strategies/jwt.md
- configuration/authentication/strategies/redis.md
- configuration/authentication/backend.md
- configuration/user-manager.md
- Routers:
- Introduction: configuration/routers/index.md
- configuration/routers/auth.md
- configuration/routers/register.md
- configuration/routers/verify.md
- configuration/routers/reset.md
- configuration/routers/users.md
- configuration/full-example.md
- configuration/oauth.md
- Usage:
- usage/flow.md
- usage/routes.md
- usage/current-user.md
- Cookbook:
- cookbook/create-user-programmatically.md
- Migration:
- migration/08_to_1x.md
- migration/1x_to_2x.md
- migration/2x_to_3x.md
- migration/3x_to_4x.md
- migration/4x_to_5x.md
- migration/6x_to_7x.md
- migration/7x_to_8x.md
- migration/8x_to_9x.md