mkdocs.yml

site_name: geOrchestra dashboards, using Apache Superset

repo_url: https://github.com/georchestra/superset
repo_name: georchestra-superset

docs_dir: docs
edit_uri: edit/main/docs/


theme:
  language: en
  features:
    # - toc.integrate
    - navigation.indexes
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.footer
  logo: images/georchestra-logo-white.svg
  favicon: images/favicon.ico
  name: material

extra:
  version:
    provider: mike
  generator: false
  social:
    - icon: fontawesome/solid/paper-plane
      link: mailto:psc@georchestra.org
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/georchestra
    - icon: fontawesome/brands/github
      link: https://github.com/georchestra
    - icon: fontawesome/brands/google
      link: https://groups.google.com/g/georchestra?hl=en
    - icon: fontawesome/brands/dev
      link: https://groups.google.com/group/georchestra-dev?hl=fr
    - icon: fontawesome/regular/comments
      link: https://kiwiirc.com/client/irc.libera.chat/georchestra


copyright: '© 2025 - geOrchestra'

extra_css:
    - css/extra.css

extra_javascript:
    - assets/custom_versions.js

# 1st and 2nd level tree structure to manage here
# These entries match the documentation template
# Here do not put .fr or .en in the name of the markdown: the i18n plugin manage this for you

nav:
    - Home: index.md 
    - User guide:
        - Index: user_guide/index.md
        - Getting started: user_guide/getting_started.md
        - Global overview: user_guide/global_overview.md
        - Menus and toolbars: user_guide/tools.md
        - Syntax help: user_guide/syntax_help.md
    - Technical guides:
        - Index: technical_guides/index.md
        - Administration:
            - technical_guides/administration/index.md
            - technical_guides/administration/manage_roles.md
            - technical_guides/administration/import_resources.md
        - Installation:
            - technical_guides/installation/index.md
            - technical_guides/installation/presentation.md
            - technical_guides/installation/prerequisites.md
            - technical_guides/installation/preparation.md
            - technical_guides/installation/install-kubernetes.md
            - technical_guides/installation/install-docker.md
            - technical_guides/installation/install-manual.md
            - technical_guides/installation/configuration.md
            - technical_guides/installation/debug.md
            - technical_guides/installation/tests.md
        - Contribute:
            - technical_guides/contribute/index.md
            - technical_guides/contribute/feature_matrix.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

plugins:
  - search
  - callouts
  # - toc-md:
      # toc_page_title: Contents
      # toc_page_description: Summary of the section
      # header_level: 3
      # pickup_description_meta: false
      # pickup_description_class: false
      # output_path: tableofcontent.md
      # output_log: true
      # ignore_page_pattern: index.md
      # remove_navigation_page_pattern: index.md
      # template_dir_path: custom_template
  - i18n:
        docs_structure: suffix
        fallback_to_default: true
        reconfigure_material: true
        reconfigure_search: true
        languages:
          - locale: en
            default: true
            name: English
            build: true
            site_name: "geOrchestra dashboards and dataviz with Superset"


  - git-revision-date-localized:
      enable_creation_date: true