mkdocs.yaml

site_name: Your private ChatGPT.
site_url: https://docqai.github.io/docq
site_description: Docq offers self-hosted, private and secure ChatGPT/Perplexity on your private data with minimal onboarding and operational effort.
site_author: Docq Contributors
copyright: Copyright © 2023 - 2024 Docq Contributors
site_dir: html
repo_name: docqai/docq
repo_url: https://github.com/docqai/docq

plugins:
  - search
  # - mkapi # doesn't work with python 3.11. project not maintained
  - awesome-pages
  #- social # disabling to temp workaround https://github.com/squidfunk/mkdocs-material/issues/6983
  - gen-files:
      scripts:
        - misc/gen_pages.py

markdown_extensions:
  - def_list
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - toc:
      permalink: true

extra:
  analytics:
    provider: google
    property: G-SML7XH761K
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/docqai
      name: docqai
    - icon: fontawesome/brands/slack
      link: https://join.slack.com/t/docqai/shared_invite/zt-27p17lu6v-6KLJxSmt61vfNqCavSE73A
      name: Join Slack
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/docqai
      name: linkedin.com/company/docqai
    - icon: fontawesome/brands/medium
      link: https://medium.com/@docqai
      name: Blog
    - icon: fontawesome/regular/envelope
      link: mailto:<hi@docqai.com>

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  logo: assets/logo.jpg
  favicon: assets/favicon.png
  language: en
  palette:    
    - media: "(prefers-color-scheme: light)"
      scheme: docq
      accent: purple
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom
      scheme: slate
      accent: purple
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.tooltips
    - navigation.instant
    - navigation.indexes
    - navigation.sections

  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left

nav:
  - "Home": index.md
  - "Overview":
      - "Introduction": overview/introduction.md
      - "Design Principles": overview/design-principles.md
      - "Key Features": overview/key-features.md
      - "Deployment Scenarios": overview/deployment-scenarios.md
  - "User Guides":
      - "Getting Started": user-guide/getting-started.md
      - "Configuration":
          - "LLM Service Configuration": user-guide/llm-config.md
          - "Configure Spaces": user-guides/config-spaces.md
          - "Configure File Storage Services": user-guides/file-storage-services.md
      - "Deploy to Streamlit": user-guide/deploy-to-streamlit.md
      - "Deploy to Azure": user-guide/deploy-to-azure.md
      - "Deploy to AWS": user-guide/deploy-to-aws.md
      - "Deploy to GCP": user-guide/deploy-to-gcp.md
      - "Configure Spaces": user-guide/config-spaces.md
      - "Data Sources": user-guide/data-sources.md
      - "Configure File Storage Services": user-guide/file-storage-services.md
      - "LLM Service Configuration": user-guide/llm-config.md
      - "Usage": user-guide/usage.md
      - "FAQ": user-guide/faq.md
  - "Developer Guides":
      - "Getting Started": developer-guide/getting-started.md
      - "Architecture": developer-guide/architecture.md
      - "Contributing": developer-guide/contributing.md
      - "Extensions": developer-guide/extensions.md
      - "Web API": developer-guide/web-api.md
      - "FAQ": developer-guide/faq.md
  #- ... | glob=readme.md
  #- ... | regex=scenarios/.+.md
  #- API: mkapi/api/docq
  #- Tests: mkapi/tests/tests
  - "Issues GitHub": https://github.com/docqai/docq/issues
  - "Join Our Slack": https://join.slack.com/t/docqai/shared_invite/zt-27p17lu6v-6KLJxSmt61vfNqCavSE73A
  - "Acknowledgement": acknowledgement.md