mkdocs.yml

site_name: GynTree Documentation
site_description: Directory tree analysis and visualization tool
site_author: dsj7419
repo_url: https://github.com/dsj7419/gyntree
repo_name: GynTree
edit_uri: edit/main/docs/
site_dir: site

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

plugins:
  - search:
      lang: en
  - awesome-pages
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true
      enable_creation_date: true
      strict: false

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - FAQ: getting-started/faq.md
  - User Guide:
      - Basic Usage: user-guide/basic-usage.md
      - Configuration: user-guide/configuration.md
  - API Reference: api/overview.md
  - Contributing:
      - Guidelines: contributing/guidelines.md
      - Issue Templates: contributing/issue_templates.md
      - Code of Conduct: code_of_conduct.md
  - Changelog: changelog.md
  - Privacy Notice: privacy.md

validation:
  nav:
    omitted_files: warn
    not_found: warn # Changed from 'error' to 'warn'
    absolute_links: warn # Changed from 'error' to 'warn'

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dsj7419/gyntree
  analytics:
    provider: google
    property: G-9W4454MMW7
    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!
  version:
    provider: mike
  generator: false

extra_javascript:
  - https://www.googletagmanager.com/gtag/js?id=G-9W4454MMW7
  - js/analytics.js

copyright: Copyright © 2024 dsj7419