mkdocs.yml

---
INHERIT: nav.yml
# {{{ Main site config
site_name: eccenca Corporate Memory documentation
site_url: https://documentation.eccenca.com/
repo_url: https://github.com/eccenca/documentation.eccenca.com
edit_uri: ./edit/main/docs
copyright: >
  Copyright © 2026
  <a target="_blank" rel="noopener" href="https://eccenca.com">eccenca GmbH</a>
extra:
  analytics:
    provider: google
    property: G-VS3GZMYY28
  # https://squidfunk.github.io/mkdocs-material/reference/?h=status#setting-the-page-status
  status:
    new: Recently added or extended
    deprecated: Deprecated
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=social#social-links
  social:
    # - icon: fontawesome/brands/docker
    # link: https://hub.docker.com/u/eccenca
    - icon: fontawesome/brands/creative-commons
      link: >
        https://github.com/eccenca/documentation.eccenca.com/blob/main/LICENSE
    - icon: fontawesome/brands/github
      link: https://github.com/eccenca
    - icon: fontawesome/brands/python
      link: https://pypi.org/user/eccenca/
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/eccenca
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/eccenca-gmbh/
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
  tags:
    # here tags are mapped to icons
    Video: video
    ReleaseNote: release-note
    Vocabulary: vocabulary
    Configuration: configuration
    Dashboards: dashboards
    BestPractice: best-practice
    KnowledgeGraph: knowledge-graph
    Java: java
    Security: security
    API: api
    Reference: reference
    Workflow: workflow
    Automate: automate
    cmemc: cmemc
    Docker: docker
    Python: python
    PythonPlugin: python-plugin
    SPARQL: sparql
    BeginnersTutorial: beginners
    AdvancedTutorial: advanced
    ExpertTutorial: expert
    Project: project
    Keycloak: keycloak
    Validation: validation
    Filesystem: material-file-tree
    Volume: fontawesome-solid-hard-drive
    "Load Balancer": load-balancer
    Variables: variables
    JDBC: jdbc
    Package: package
    Marketplace: marketplace
    "Application View": application-view
    Integration: integration
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
  version:
    provider: mike
  # https://squidfunk.github.io/mkdocs-material/setup/ensuring-data-privacy/#cookie-consent
  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.
# https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#custom-syntax-theme
extra_css:
  - assets/fonts.css
  - assets/extra.css
extra_javascript:
  # https://squidfunk.github.io/mkdocs-material/reference/data-tables/#sortable-tables
  - assets/tablesort.min.js
  - assets/tablesort.js
  - assets/extra.js
# }}}

# {{{ Theme configuration
theme:
  name: material
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/
  language: en

  # https://squidfunk.github.io/mkdocs-material/customization/#extending-the-theme
  custom_dir: overrides

  # used from assets/extra.css
  palette:
    - scheme: eccenca-light

  # Fonts are self-hosted, see docs/assets/fonts.css. `false` suppresses the
  # <link> tags to fonts.googleapis.com / fonts.gstatic.com; the families are
  # set via --md-text-font / --md-code-font there instead.
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-fonts/
  font: false

  favicon: assets/favicon.svg
  logo: assets/favicon.svg

  features:
    # add button to dismiss the current announcement
    - announce.dismiss
    # on search highlight all occurrences after following the link
    - search.highlight
    # allows to deep link to the current search query and result
    - search.share
    # search will display the likeliest completion for the last word
    - search.suggest
    # sidebar is scrolled so that the active anchor is always visible
    - toc.follow
    # allow numeric annotion markers in block and inline comments
    - content.code.annotate
    # same label tabs are linked and switch to the same label
    - content.tabs.link
    # replaces the browser tooltips
    - content.tooltips
    # documents can be directly attached to sections, which is particularly
    # useful for providing overview pages.
    - navigation.indexes
    # renders a breadcrumb trail above the content
    - navigation.path
    # clicks on all internal links will be intercepted and dispatched via XHR
    # without fully reloading the page
    - navigation.instant
    # top-level sections are rendered in a menu layer below the header
    - navigation.tabs
    # top level sections will lock below the header and always remain visible
    - navigation.tabs.sticky
    # add back-to-top button
    - navigation.top
    # URL in the address bar is automatically updated with the active anchor as
    # highlighted in the table of contents.
    - navigation.tracking
    # left sidebar will expand all collapsible subsections by default
    # - navigation.expand
    # significantly smaller HTML files for documentation projects with huge
    # navigation hierarchies.
    # - navigation.prune
    # top-level sections are rendered as groups in the sidebar for viewports
    # above 1220px
    # - navigation.sections
    # - header.autohide
    # - toc.integrate

  # 404 page

  # Necessary for search to work properly

  icon:
    tag:
      # https://squidfunk.github.io/mkdocs-material/reference/?h=page+icon#setting-the-page-icon
      video: material/video-outline
      release-note: material/calendar
      vocabulary: material/graph-outline
      configuration: material/tune
      dashboards: material/view-dashboard
      best-practice: material/thumb-up-outline
      knowledge-graph: eccenca/artefact-dataset-eccencadataplatform
      java: material/language-java
      security: material/server-security
      api: material/api
      reference: octicons/cross-reference-24
      workflow: eccenca/artefact-workflow
      automate: other/powerautomate
      cmemc: octicons/terminal-16
      docker: fontawesome/brands/docker
      python: fontawesome/brands/python
      python-plugin: fontawesome/brands/python
      sparql: material/database-eye-outline
      beginners: material/list-status
      advanced: material/list-status
      expert: material/list-status
      project: eccenca/artefact-project
      keycloak: material/openid
      validation: octicons/verified-16
      material-file-tree: material/file-tree
      load-balancer: other/load-balancer
      fontawesome-solid-hard-drive: fontawesome/solid/hard-drive
      variables: material/variable-box
      jdbc: material/database
      package: eccenca/module-marketplace
      marketplace: eccenca/module-marketplace
      application-view: eccenca/module-workspace-configuration
    # https://squidfunk.github.io/mkdocs-material/reference/annotations/
    admonition:
      note: fontawesome/solid/note-sticky
      abstract: fontawesome/solid/book
      info: fontawesome/solid/circle-info
      tip: fontawesome/solid/bullhorn
      success: fontawesome/solid/check
      question: fontawesome/solid/circle-question
      warning: fontawesome/solid/triangle-exclamation
      failure: fontawesome/solid/bomb
      danger: fontawesome/solid/skull
      bug: fontawesome/solid/robot
      example: fontawesome/solid/flask
      quote: fontawesome/solid/quote-left
# }}}

# {{{ Extensions to the markdown processor
markdown_extensions:
  # These, plus `attr_list`, `md_in_html` and `pymdownx.superfences` further
  # down, are exactly the members of `pymdownx.extra`. They are listed out
  # rather than pulled in as that bundle so it stays visible that superfences
  # carries our `custom_fences` configuration.
  #
  # Do NOT use `markdown.extensions.extra` here: it bundles `fenced_code`,
  # which claims the same ``` syntax as superfences. superfences is documented
  # to replace fenced_code, and enabling both is unsupported - the precedence
  # between them then depends on hash ordering, so builds randomly handed the
  # fence to fenced_code, which does not understand `title="..."`. The fence
  # never opened and the rest of the page, headings and anchors included, was
  # emitted as raw text. See zensical/zensical#882 and
  # https://facelessuser.github.io/pymdown-extensions/usage_notes/
  #
  # https://facelessuser.github.io/pymdown-extensions/extensions/extra/
  - pymdownx.betterem
  - abbr
  - def_list
  - footnotes
  - tables
  # converts ASCII dashes, quotes and ellipses to their HTML entity equivalents
  - smarty
  # ordered list will not continue when an unordered item comes and vice versa
  - sane_lists
  # add HTML attributes and CSS classes to Markdown inline and block elements
  - attr_list
  # writing Markdown inside of HTML
  - md_in_html
  # https://squidfunk.github.io/mkdocs-material/reference/annotations/
  - admonition
  # collapsible admonitions
  - pymdownx.details
  # support for syntax highlighting of code blocks
  - pymdownx.highlight:
      anchor_linenums: true
  # support for syntax highlighting of inline code blocks
  - pymdownx.inlinehilite
  # adds the ability to embed content from arbitrary files into a document
  - pymdownx.snippets
  # https://squidfunk.github.io/mkdocs-material/reference/formatting/#adding-keyboard-keys
  - pymdownx.keys
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#tasklist
  - pymdownx.tasklist:
      custom_checkbox: true
  # allows the usage of content tabs, a simple way to group related content
  - pymdownx.tabbed:
      alternate_style: true
  # arbitrary nesting of code and content blocks inside each other
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  # generates a Table of Contents from a Markdown document with [TOC]
  - toc:
      permalink: '¤'
      baselevel: 1
      # toc_depth: 4
  # automatically inlines bundled and custom icons and emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      # https://squidfunk.github.io/mkdocs-material/setup/changing-the-logo-and-icons/#additional-icons
      options:
        custom_icons:
          - overrides/.icons
# }}}

# {{{ Extensions to mkdocs - some of them are used by material theme
plugins:
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  # No `lang: en` here: English is the default, and Zensical does not implement
  # the option. 0.0.60 rejected it as a hard build error; since 0.0.61 it is
  # accepted and discarded again, so adding it back changes nothing.
  - search
  # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
  - awesome-pages
  # https://github.com/fralau/mkdocs_macros_plugin
  # - macros
  # https://github.com/blueswen/mkdocs-glightbox
  - glightbox
  # Natively implemented since Zensical 0.0.61: writes a redirect page at every
  # old URL. `--strict` fails on a target that does not exist, and
  # tools/check_zensical_output.py checks that each page redirect lands.
  # https://zensical.org/docs/setup/redirects/
  - redirects:
      redirect_maps:
        cmemc/index.md: automate/cmemc-command-line-interface/index.md
        # yamllint disable-line rule:line-length
        explore-and-author/building-a-customized-user-interface/index.md: explore-and-author/graph-exploration/building-a-customized-user-interface/index.md
        # Release notes were regrouped into year directories; the flat paths
        # below are what external links and search results still point at.
        release-notes/corporate-memory-19-10/index.md: release-notes/2019/corporate-memory-19-10/index.md
        release-notes/corporate-memory-20-03/index.md: release-notes/2020/corporate-memory-20-03/index.md
        release-notes/corporate-memory-20-06/index.md: release-notes/2020/corporate-memory-20-06/index.md
        release-notes/corporate-memory-20-10/index.md: release-notes/2020/corporate-memory-20-10/index.md
        release-notes/corporate-memory-20-12/index.md: release-notes/2020/corporate-memory-20-12/index.md
        release-notes/corporate-memory-21-02/index.md: release-notes/2021/corporate-memory-21-02/index.md
        release-notes/corporate-memory-21-04/index.md: release-notes/2021/corporate-memory-21-04/index.md
        release-notes/corporate-memory-21-06/index.md: release-notes/2021/corporate-memory-21-06/index.md
        release-notes/corporate-memory-21-11/index.md: release-notes/2021/corporate-memory-21-11/index.md
        release-notes/corporate-memory-22-1/index.md: release-notes/2022/corporate-memory-22-1/index.md
        release-notes/corporate-memory-22-2/index.md: release-notes/2022/corporate-memory-22-2/index.md
        release-notes/corporate-memory-23-1/index.md: release-notes/2023/corporate-memory-23-1/index.md
        release-notes/corporate-memory-23-2/index.md: release-notes/2023/corporate-memory-23-2/index.md
        release-notes/corporate-memory-23-3/index.md: release-notes/2023/corporate-memory-23-3/index.md
        release-notes/corporate-memory-24-1/index.md: release-notes/2024/corporate-memory-24-1/index.md
        release-notes/corporate-memory-24-2/index.md: release-notes/2024/corporate-memory-24-2/index.md
        release-notes/corporate-memory-24-3/index.md: release-notes/2024/corporate-memory-24-3/index.md
        release-notes/corporate-memory-25-1/index.md: release-notes/2025/corporate-memory-25-1/index.md
        release-notes/corporate-memory-25-2/index.md: release-notes/2025/corporate-memory-25-2/index.md
        release-notes/corporate-memory-25-3/index.md: release-notes/2025/corporate-memory-25-3/index.md
        release-notes/corporate-memory-26-1/index.md: release-notes/2026/corporate-memory-26-1/index.md
        release-notes/corporate-memory-26-2/index.md: release-notes/2026/corporate-memory-26-2/index.md
  # Natively implemented since Zensical 0.0.67. The colors are required: the
  # default card layout reads `theme.palette.primary`, which the custom scheme
  # leaves unset, and the build aborts on it. #0a66a3 is --md-primary-fg-color
  # in docs/assets/extra.css. The font defaults to Roboto, the site font.
  # https://zensical.org/docs/setup/social-cards/
  - social:
      cards: true
      cards_layout_options:
        background_color: "#0a66a3"
        color: "#ffffff"
  # Inert under Zensical: it neither implements nor reports the plugin, so
  # revision dates are missing from the output. It is kept so the feature
  # returns automatically once Zensical maps it.
  # tools/check_zensical_output.py tracks it.
  # https://github.com/timvink/mkdocs-git-revision-date-localized-plugin
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  # Natively implemented since Zensical 0.0.58 (listings included).
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-tags/
  - tags:
      listings_tags_sort_by: !!python/name:material.plugins.tags.tag_name_casefold
      listings_sort_by: !!python/name:material.plugins.tags.item_title
# }}}

# {{{ Less important mkdocs configuration
# https://zensical.org/docs/setup/basics/#watch
# watch:
#  - overrides
# }}}