mkdocs.yml

site_name: Corridor GGX Documentation
site_url: 'https://corridor.github.io/ggx-docs/'
use_directory_urls: true
copyright: '© Corridor Platforms'
repo_url: https://github.com/corridor/ggx-docs
repo_name: 'corridor/ggx-docs'
edit_uri: edit/main/docs/

extra_css:
  - assets/stylesheets/print-pdf.css
  - assets/stylesheets/extra.css

extra_javascript:
  - assets/javascripts/mermaid.min.js # Added mermaid here to avoid using CDN in production

# Copyright
copyright: Copyright © Corridor Platforms

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/corridor
      name: GitHub
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/corridor-platforms/
      name: LinkedIn
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@corridorplatforms
      name: YouTube
    - icon: fontawesome/brands/google
      link: https://cloud.google.com/find-a-partner/partner/corridor-platforms
      name: Google Partner
    # - icon: material/file-pdf-box
    #   link: /assets/pdfs/user_manual.pdf
    #   name: Download User Manual (PDF)
    #   target: _blank
  analytics:
    provider: google
    property: G-SMFMDV1JW7
    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!

theme:
  name: material
  favicon: assets/logos/favicon.ico
  logo: assets/logos/ggx-white.png
  font:
    text: DM Sans
    code: DM Mono
  palette:
    - scheme: corridor
      primary: rgb(41, 49, 71)
      accent: rgb(41, 49, 71)
  features:
    - navigation.expand
    - navigation.instant
    - navigation.instant.progress
    - navigation.instant.prefetch
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - navigation.path
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit
    - content.action.edit.top
    - content.time.last_updated
    - content.code.select
    - content.code.annotate
    - toc.follow

plugins:
  - search
  - htmlproofer:
      raise_error_after_finish: False
  - unused_files:
      excluded_files:
        - .pages
      enabled: !ENV [CI, false]
  - awesome-nav
  - with-pdf:
      # Set author/copyright as a space - using '' or not setting it causes the value 'None' to be shown in PDF
      author: ' '
      copyright: ' '
      cover_title: Corridor GenGuardX
      toc_level: 2
      output_path: assets/pdfs/user_manual.pdf
      enabled_if_env: ENABLE_PDF_EXPORT
      # theme_handler_path: The path to customize the PDF generation for our theme
      theme_handler_path: pdf_handler.py
  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: false
      caption_position: bottom
      background: white
      shadow: true
  - git-revision-date
  - git-authors:
      show_email_address: false

markdown_extensions:
  - meta
  - toc:
      permalink: true
  - tables
  - fenced_code
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.inlinehilite
  - abbr
  - admonition
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true