mkdocs.yml

site_name: ''
site_description: Ellar - Python ASGI web framework for building fast, efficient and scalable RESTAPIs and server-side application.
site_url: https://github.com/python-ellar/ellar
repo_name: eadwinCode/ellar
repo_url: https://github.com/python-ellar/ellar
edit_uri: blob/master/docs
copyright: |
  Copyright &copy; 2024 <a href="https://github.com/eadwinCode"  target="_blank" rel="noopener">Eadwin Ezeudoh</a>

docs_dir: docs
site_dir: site

theme:
  name: material
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.prune
    - navigation.tabs
    - navigation.left
    - navigation.tracking
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  font:
    text: Source Sans Pro
    code: Fira Code
  language: en
  logo: img/EllarLogoB.png
  favicon: img/Icon.svg
  icon:
    repo: fontawesome/brands/git-alt

plugins:
  - search:
        separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
        minify_html: true
  - git-revision-date-localized:
      enable_creation_date: false
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: true
            show_source: false

nav:
  - Get Started:
      - Get Started: index.md
      - Quick Setup: quick-project.md
      - Contribution: contribution.md
      - Release Notes: release-notes.md
  - Overview:
      - Step One:  overview/step-one.md
      - Controllers:  overview/controllers.md
      - Providers:  overview/providers.md
      - Modules:  overview/modules.md
      - Middlewares:  overview/middleware.md
      - Exception Handling:  overview/exception_handling.md
      - Guards:  overview/guards.md
      - Custom Decorators:  overview/custom_decorators.md
      - Module Router:  overview/module-router.md
      - Interceptors:  overview/interceptors.md
  - Essentials:
      - Execution Context: basics/execution-context.md
      - Dynamic Modules: basics/dynamic-modules.md
      - Injector Scopes: basics/injector-scopes.md
      - Lifespan: basics/lifespan.md
      - Application Context: basics/application-context.md
      - Testing: basics/testing.md
  - Techniques:
      - Configuration: techniques/configurations.md
      - Input Validations:
          - Index: techniques/validations/index.md
          - Path: techniques/validations/path-params.md
          - Query: techniques/validations/query-params.md
          - Header: techniques/validations/header-params.md
          - Cookie: techniques/validations/cookie-params.md
          - Body: techniques/validations/body.md
          - Form: techniques/validations/form-params.md
          - File: techniques/validations/file-params.md
      - Serializers: techniques/serializers.md
      - Response Model: techniques/response-model.md
      - Versioning: techniques/versioning.md
      - Caching: techniques/caching.md
      - Templating:
          - Html: techniques/templating.md
          - Static Files: techniques/staticfiles.md
      - Mount: techniques/mount.md
      - Background Tasks: techniques/background-task.md

  - Security:
      - Authentication:
          - Guard Strategy: security/authentication/guard-strategy.md
          - Authentication Scheme Strategy: security/authentication/auth-handler-strategy.md
          - JWT Authentication: security/authentication/jwt-authentication.md
          - API Key Authentication: security/authentication/api-key-authentication.md
      - Authorization: 
          - index: security/authorization.md
          - Policies: security/authorization/policies.md
          - Role-Based Authorization: security/authorization/role-based.md
          - Claims-Based Authorization: security/authorization/claims-based.md
          - Custom Policies with Requirements: security/authorization/custom-policies.md
          - Combining Policies: security/authorization/combining-policies.md
      - Encryption and Hashing: security/encryption_and_hashing.md
      - CSRF and CORS: security/csrf.md
      - Sessions: security/sessions.md
      - Rate Limiting: security/rate-limit.md

  - CLI:
    - Introduction: cli/introduction.md
    - Commands:
        - new: cli/new-command.md
        - create project: cli/create-project-command.md
        - create module: cli/create-module-command.md
        - runserver: cli/runserver-command.md
    - Custom Commands: cli/custom-commands.md

  - OPENAPI:
      - index: openapi/index.md
      - Security: openapi/security.md
      - Document UI: openapi/document-ui.md
  - WebSockets:
      - index: websockets/websockets.md
      - Socketio: websockets/socketio.md

markdown_extensions:
  - attr_list
  - toc:
      permalink: true
  - admonition
  - def_list
  - tables
  - abbr
  - footnotes
  - md_in_html
  - codehilite
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.saneheaders
  - pymdownx.tilde

extra_css:
  - stylesheets/extra.css