mkdocs.yml

site_name: IP Fabric Documentation Portal
site_url: https://docs.ipfabric.io
repo_url: https://github.com/ipfabric/docs
repo_name: ipfabric/docs
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.png
  custom_dir: overrides
  features:
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - navigation.expand
    - navigation.footer
    - navigation.path
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.follow

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: ipfabric
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - mdx_truly_sane_lists
  - smarty
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tilde

extra_css:
  - stylesheets/theme.css

extra:
  analytics:
    provider: google
    property: G-2EJL11ZZ7X
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://ipfabric.atlassian.net/servicedesk/customer/portal/1" target="_blank" rel="noopener">support portal</a>.
  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.
  generator: false
  social:
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/ipfabric.io
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/channel/UCLztlukjD9RKFGkrKgxMT1w/featured
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/IPFabric
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ip-fabric/
  version:
    provider: mike

plugins:
  - awesome-pages:
      filename: .pages.yml
  - git-revision-date-localized:
      strict: false
  - search:
  - social:
      cards_color:
        fill: "#264183"
        text: "#FFFFFF"
  - glightbox:
      zoomable: true
  - mkdocs_exclude_tagged_files:
      tags_to_exclude:
        - draft
        - excluded
  - open-in-new-tab:
  - mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: latest