Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 49 additions & 46 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ theme:
primary: custom
accent: custom
toggle:
icon: material/brightness-7
icon: material/brightness-7
name: Switch to dark mode

- media: "(prefers-color-scheme: dark)"
Expand All @@ -47,51 +47,51 @@ plugins:
nav:
- Home: index.md
- Getting Started:
- Overview: getting-started/index.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- First Run: getting-started/first-run.md
- Overview: getting-started/index.md
- Installation: getting-started/installation.md
- Configuration: getting-started/configuration.md
- First Run: getting-started/first-run.md
- User Guide:
- Overview: user-guide/index.md
- Project Structure: user-guide/project-structure.md
- Configuration:
- Overview: user-guide/configuration/index.md
- Environment Variables: user-guide/configuration/environment-variables.md
- Settings Classes: user-guide/configuration/settings-classes.md
- Docker Setup: user-guide/configuration/docker-setup.md
- Environment-Specific: user-guide/configuration/environment-specific.md
- Database:
- Overview: user-guide/database/index.md
- Models: user-guide/database/models.md
- Schemas: user-guide/database/schemas.md
- CRUD Operations: user-guide/database/crud.md
- Migrations: user-guide/database/migrations.md
- API:
- Overview: user-guide/api/index.md
- Endpoints: user-guide/api/endpoints.md
- Pagination: user-guide/api/pagination.md
- Exceptions: user-guide/api/exceptions.md
- Versioning: user-guide/api/versioning.md
- Authentication:
- Overview: user-guide/authentication/index.md
- JWT Tokens: user-guide/authentication/jwt-tokens.md
- User Management: user-guide/authentication/user-management.md
- Permissions: user-guide/authentication/permissions.md
- Admin Panel:
- user-guide/admin-panel/index.md
- Configuration: user-guide/admin-panel/configuration.md
- Adding Models: user-guide/admin-panel/adding-models.md
- User Management: user-guide/admin-panel/user-management.md
- Caching:
- Overview: user-guide/caching/index.md
- Redis Cache: user-guide/caching/redis-cache.md
- Client Cache: user-guide/caching/client-cache.md
- Cache Strategies: user-guide/caching/cache-strategies.md
- Background Tasks: user-guide/background-tasks/index.md
- Rate Limiting: user-guide/rate-limiting/index.md
- Development: user-guide/development.md
- Production: user-guide/production.md
- Testing: user-guide/testing.md
- Overview: user-guide/index.md
- Project Structure: user-guide/project-structure.md
- Configuration:
- Overview: user-guide/configuration/index.md
- Environment Variables: user-guide/configuration/environment-variables.md
- Settings Classes: user-guide/configuration/settings-classes.md
- Docker Setup: user-guide/configuration/docker-setup.md
- Environment-Specific: user-guide/configuration/environment-specific.md
- Database:
- Overview: user-guide/database/index.md
- Models: user-guide/database/models.md
- Schemas: user-guide/database/schemas.md
- CRUD Operations: user-guide/database/crud.md
- Migrations: user-guide/database/migrations.md
- API:
- Overview: user-guide/api/index.md
- Endpoints: user-guide/api/endpoints.md
- Pagination: user-guide/api/pagination.md
- Exceptions: user-guide/api/exceptions.md
- Versioning: user-guide/api/versioning.md
- Authentication:
- Overview: user-guide/authentication/index.md
- JWT Tokens: user-guide/authentication/jwt-tokens.md
- User Management: user-guide/authentication/user-management.md
- Permissions: user-guide/authentication/permissions.md
- Admin Panel:
- user-guide/admin-panel/index.md
- Configuration: user-guide/admin-panel/configuration.md
- Adding Models: user-guide/admin-panel/adding-models.md
- User Management: user-guide/admin-panel/user-management.md
- Caching:
- Overview: user-guide/caching/index.md
- Redis Cache: user-guide/caching/redis-cache.md
- Client Cache: user-guide/caching/client-cache.md
- Cache Strategies: user-guide/caching/cache-strategies.md
- Background Tasks: user-guide/background-tasks/index.md
- Rate Limiting: user-guide/rate-limiting/index.md
- Development: user-guide/development.md
- Production: user-guide/production.md
- Testing: user-guide/testing.md
# - Examples:
# - Overview: examples/index.md
# - Basic CRUD: examples/basic-crud.md
Expand Down Expand Up @@ -146,10 +146,13 @@ extra:
link: https://pypi.org/project/fastapi/
version:
provider: mike
analytics:
provider: google
property: !ENV [GOOGLE_ANALYTICS_KEY, ""]

extra_css:
- stylesheets/extra.css

repo_name: benavlabs/fastapi-boilerplate
repo_url: https://github.com/benavlabs/fastapi-boilerplate
edit_uri: edit/main/docs/
edit_uri: edit/main/docs/