mkdocs.yml

site_name: Excalibase GraphQL
site_description: Automatic GraphQL API generation from multiple databases
site_author: Excalibase Team
site_url: https://excalibase.github.io/excalibase-graphql/

repo_name: excalibase/excalibase-graphql
repo_url: https://github.com/excalibase/excalibase-graphql

copyright: Copyright © 2024 Excalibase Team

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
    logo: material/database

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/excalibase/excalibase-graphql
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/excalibase/excalibase-graphql

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: excalibase
      repo: excalibase-graphql
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Choose Your Protocol: choose-your-protocol.md
  - Quick Start:
      - Getting Started: quickstart/index.md
      - Installation Guide: quick-start.md
  - GraphQL:
      - Overview: graphql/index.md
      - Filtering: graphql/filtering.md
  - REST:
      - Overview: rest/index.md
      - Filtering: rest/filtering.md
      - Mutations: rest/mutations.md
      - Pagination: rest/pagination.md
  - Features:
      - Multi-Schema Support: features/multi-schema.md
      - MySQL Support: features/mysql.md
      - Stored Procedures: features/stored-procedures.md
      - Enhanced PostgreSQL Types: features/enhanced-postgresql-types.md
      - Full-Text & Vector Search: features/search-and-vector.md
      - Real-Time Subscriptions: features/subscriptions.md
      - Row-Level Security: features/user-context-rls.md
      - Postgres Role Switching: features/postgres-role-switching.md
  - Database Compatibility: database-compatibility.md
  - SDK (TypeScript): sdk.md
  - Testing: testing.md
  - Contributing: CONTRIBUTING.md