mkdocs.yml

# Project information
site_name: JKUM
site_url: https://www.jkum.info/
site_author: Hans Martin Eikerol
site_description: >-
  A brand new system description for establishing data flow related to manhole data
  across applications. Based on the well-established JSON-file format to allow integrations
  for web-based applications as well.
  
  
  Here you will find all relevant information about the requirements and possibilities of
  this file format, and you can validate your files.

# Repository
repo_name: VA-Visjon/jkum-site
repo_url: https://github.com/VA-Visjon/jkum-site
edit_uri: edit/main/docs/

# Copyright
copyright: Copyright © 2020 - 2024 Hans Martin Eikerol

theme:
  name: material
  logo: assets/images/sandfang.png
  favicon: assets/images/sandfang.png
  custom_dir: overrides
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.code.select
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: cyan
      accent: light blue
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      accent: cyan
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

# Custom css
extra_css:
  - stylesheets/extra.css
  - stylesheets/validator.css
  - stylesheets/viewer.css
  - stylesheets/forms.css
  - stylesheets/drag-and-drop.css

# Extensions
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:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: index.md
  - Validator: validator.md
  - Getting started:
      - Introduction: introduction.md
      - File downloads: file-downloads.md
  - For developers:
      - File structure: file-structure.md
      - Examples: examples.md
      - Roadmap: roadmap.md
      - Third-party code: third-party-code.md
  - Viewer: viewer.md
  - Editor: editor.md
#  - 'Issue Tracker': 'https://github.com/VA-Visjon/jkum-site/issues'

plugins:
  - search
  #- schema_reader:
  #    include:
  #      - "schemas/"