mkdocs.yml

site_name: Data Quality CLI for the Auto-Alerts
site_url: https://infinitelambda.github.io/diqu/
site_author: Infinite Lambda
site_description: Offical documentation of `diqu` CLI

repo_name: infinitelambda/diqu
repo_url: https://github.com/infinitelambda/diqu
edit_uri: edit/main/docs/

copyright: Copyright © 2023 Infinite Lambda

nav:
  - diqu - Quick Start:
    - Quick Start: index.md
    - User Guide:
      - General: nav/guide/common.md
      - Alerting Configuration:
        - Slack: nav/guide/config/alerts/slack.md
        - JIRA: nav/guide/config/alerts/jira.md
      - Data Sources Configuration:
        - Snowflake: nav/guide/config/sources/snowflake.md
        - Custom via CSV file: nav/guide/config/sources/custom.md
      - Packages Configuration:
        - DQ Tools: nav/guide/config/packages/dq-tools.md
        - Custom query: nav/guide/config/packages/custom.md
    - CLI Reference: nav/guide/cli.md
    - Contribution Guideline: nav/dev/contributing.md
    - Change Log ↗️: https://github.com/infinitelambda/diqu/releases" target="_blank

theme:
  name: material
  custom_dir: docs/overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      primary: black
      scheme: slate
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: black
      scheme: default
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.ico
  logo: assets/favicon.ico
  icon:
    repo: fontawesome/brands/github

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

extra:
  version:
    provider: mike
  annotate:
    json: [.s2]
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/infinitelambda
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/infinite-lambda/
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/heart
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/heart-broken
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/infinitelambda/diqu/issues/new/?title=[DOCS]+{title}+-+{url}" target=_blank>feedback form</a>.

extra_css:
  - assets/css/termynal.css

extra_javascript:
  - assets/js/feedback.js
  - assets/js/termynal.js
  - assets/js/custom.js

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:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.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: squidfunk
      repo: mkdocs-material
  - 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
  - codehilite:
      guess_lang: false