mkdocs.yml

site_name: FastAPI RESTful
site_description: FastAPI RESTful
site_url: https://fastapi-restful.netlify.app/

theme:
  name: 'material'
  palette:
    primary: 'green'
    accent: 'orange'
  logo: 'img/icon-white.svg'
  favicon: 'img/favicon.png'

repo_name: yuval9313/FastApi-RESTful
repo_url: https://github.com/yuval9313/fastapi-restful

nav:
  - FastAPI RESTful: 'index.md'
  - User Guide:
      - Class Resource: 'user-guide/class-resource.md'
      - Class Based Views: 'user-guide/class-based-views.md'
      - Repeated Tasks: 'user-guide/repeated-tasks.md'
      - Timing Middleware: 'user-guide/timing-middleware.md'
      - SQLAlchemy Sessions: 'user-guide/session.md'
      - OpenAPI Spec Simplification: 'user-guide/openapi.md'
      - Other Utilities:
          - APIModel: 'user-guide/basics/api-model.md'
          - APISettings: 'user-guide/basics/api-settings.md'
          - String-Valued Enums: 'user-guide/basics/enums.md'
          - CamelCase Conversion: 'user-guide/basics/camelcase.md'
          - GUID Type: 'user-guide/basics/guid-type.md'
  - Get Help: 'help-fastapi-restful.md'
  - Development - Contributing: 'contributing.md'
  - Release Notes: 'release-notes.md'

markdown_extensions:
  - toc:
      permalink: true
  - markdown.extensions.codehilite:
      guess_lang: false
  - markdown_include.include:
      base_path: docs
  - admonition
  - codehilite
  - extra
  - tables
  - smarty

extra:
  social:
    - icon: 'fontawesome/brands/github-alt'
      link: 'https://github.com/yuval9313/fastapi-restful'

extra_css:
  - 'css/custom.css'