mkdocs.yml

# ###############################
# Main config file for MkDocs.
# ###############################
#
# To run:
# mkdocs serve
# More help: https://www.holunda.io/camunda-bpm-taskpool/developer-guide/project-setup.html#build-documentation
# ###############################

site_name: Camunda Platform Correlate
site_url: https://www.holunda.io/camunda-bpm-correlate/
site_author: Holisticon BPM Craftsman
site_description: >-
 Camunda Platform Correlate is an open-source framework for correlation of messages
 from external systems with workflows running in Camunda Platform 7 process engine.

copyright: Copyright © 2022, Holisticon AG

use_directory_urls: false

# Repository
repo_name: holunda-io/camunda-bpm-correlate
repo_url: https://github.com/holunda-io/camunda-bpm-correlate/
edit_uri: edit/develop/docs/

markdown_extensions:
    - attr_list
    - toc:
        permalink: "#"
    - pymdownx.highlight
    - pymdownx.superfences
    - pymdownx.details
    - admonition


theme:
  name: material
  features:
    - navigation.instant # When instant loading is enabled, clicks on all internal links will be intercepted and dispatched via XHR without fully reloading the page
    - navigation.tabs # add top level nav items into a horizoneal menu
    - navigation.tabs.sticky # make horizontal menu sticky (insider feature)
    - navigation.sections
    - navigation.top # add "navigate to top" page icon on bottom left
    - toc.integrate # integrate site TOC into the menu on the left
  logo: assets/img/camunda-logo.png
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

extra_css: [ assets/css/extra.css ]

extra:
  social:
    - icon: fontawesome/brands/twitter
      name: Holisticon on Twitter
      link: https://twitter.com/holisticon
    - icon: fontawesome/brands/medium
      name: Holisticon BPM Craftsmen on Medium
      link: https://medium.com/holisticon-consultants/tagged/mpb
  version:
    provider: mike

plugins:
  - search
#  - git-committers:
#      repository: holunda-io/camunda-bpm-taskpool
#      branch: master
#      token: !!python/object/apply:os.getenv ["MKDOCS_GIT_COMMITTERS_APIKEY"]
  - mike:
      # these fields are all optional; the defaults are as below...
      version_selector: true   # set to false to leave out the version selector
      css_dir: css                    # the directory to put the version selector's CSS
      javascript_dir: js            # the directory to put the version selector's JS
      canonical_version: null  # the version for <link rel="canonical">; `null`
                                            # uses the version specified via `mike deploy`
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Introduction:
      - Start here: introduction/index.md
      - Motivation: introduction/motivation.md
      - Features: introduction/features.md
      - Solution: introduction/solution.md
      - Further Outlook: introduction/further-outlook.md
  - User Guide:
      - Overview: user-guide/index.md
      - Architecture: user-guide/architecture.md
      - Components:
          - Ingress Adapter: user-guide/ingress.md
          - Spring Cloud Ingress Adapter: user-guide/ingress-spring-cloud.md
          - Axon Framework Ingress Adapter: user-guide/ingress-axon.md
          - Message Acceptor: user-guide/message-acceptor.md
          - Message Filter: user-guide/filtering-messages.md
          - Message Persistence: user-guide/message-persistence.md
          - Scheduled Processing: user-guide/scheduled-processing.md
      - Examples: user-guide/examples.md
  - Developer Guide:
      - Contributing: developer-guide/contribution.md
      - Project Setup: developer-guide/project-setup.md