mkdocs.yml

site_name: Unity Catalog
edit_uri: edit/main/docs/
repo_name: unitycatalog/unitycatalog
repo_url: https://github.com/unitycatalog/unitycatalog
site_url: https://docs.unitycatalog.io
site_description: Open, Multi-modal Catalog for Data & AI
site_author: unitycatalog

nav:
  - Home: index.md
  - Getting Started:
      - Quickstart: quickstart.md
      - Docker Compose: docker_compose.md
  - Usage:
      - CLI: usage/cli.md
      - UI: usage/ui.md
      - Tables:
          - Delta Lake: usage/tables/deltalake.md
          - Formats: usage/tables/formats.md
          - UniForm: usage/tables/uniform.md
      - Volumes: usage/volumes.md
      - Functions: usage/functions.md
      - Models: usage/models.md
  - Server:
      - Configuration: server/configuration.md
      - Auth: server/auth.md
  - Integrations:
      - Apache Spark: integrations/unity-catalog-spark.md
      - CelerData: integrations/unity-catalog-celerdata.md
      - Daft: integrations/unity-catalog-daft.md
      - DuckDB: integrations/unity-catalog-duckdb.md
      - PuppyGraph: integrations/unity-catalog-puppygraph.md
      - SpiceAI: integrations/unity-catalog-spiceai.md
      - Trino: integrations/unity-catalog-trino.md
      - XTable: integrations/unity-catalog-xtable.md
  - Deployment: deployment.md

exclude_docs: |
  README.md

plugins:
  - search
  - material-plausible

theme:
  name: material
  logo: assets/images/uc-logo-mark-reverse.png
  favicon: assets/images/unitycatalog_256x256.png
  font:
    text: Plus Jakarta Sans
    code: Consolas
  features:
    - content.action.edit
    - content.code.copy
    - content.tabs.link
    - navigation.footer
    - navigation.expand
    - navigation.indexes
    - content.code.annotate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github
    annotation: material/arrow-right-circle
extra_css:
  - assets/stylesheets/extra.css

extra:
  homepage: https://unitycatalog.io
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/unitycatalog/unitycatalog
  analytics:
    provider: plausible
    domain: unitycatalog.io
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: good
          note: >-
            Thanks for your feedback!

        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: bad
          note: >-
            Thanks for your feedback!

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
        - name: plantuml
          class: plantuml
          format: !!python/name:pymdownx.superfences.fence_code_format