mkdocs.yml

site_name: Digital Twin as a Service (DTaaS)

repo_url: https://github.com/into-cps-association/DTaaS
repo_name: DTaaS
copyright: Copyright © 2022 - 2026 The INTO-CPS Association

theme:
  name: material
  locale: en
  logo: assets/dtaas-logo.png
  favicon: assets/dtaas-logo.png
  features:
    - navigation.tabs
    - navigation.tracking
    - navigation.footer

nav:
  - Home: index.md
  - Playlist: playlist.md
  - User:
      - Motivation: user/motivation.md
      - Features: user/features.md
      - Website:
          - Overview: user/website/index.md
          - Settings: user/website/settings.md
      - Reusable Assets:
          - Concept: user/servers/lib/assets.md
          - Microservice: user/servers/lib/LIB-MS.md
          - DevOps: user/library/devops/ui.md
      - Digital Twins:
          - Create: user/digital-twins/create.md
          - Lifecycle: user/digital-twins/lifecycle.md
          - DevOps:
              - Digital Twin Structure:
                  user/digital-twins/devops/file-structure.md
              - User Interface: user/digital-twins/devops/ui.md
              - Settings: user/digital-twins/devops/execution-settings.md
              - Capabilities: user/digital-twins/devops/capabilities.md
              - Concurrent Execution:
                  user/digital-twins/devops/concurrent-execution.md
      - Gitlab Tutorial: user/gitlab/tutorial.md
      - Runner: user/servers/execution/runner/readme.md
      - Examples:
          - Overview: user/examples/index.md
          - Mass Spring Damper: user/examples/mass-spring-damper/README.md
          - Water Tank Fault Injection: user/examples/water_tank_FI/README.md
          - Water Tank Model Swap: user/examples/water_tank_swap/README.md
          - Desktop Robotti and RabbitMQ:
              user/examples/drobotti-rmqfmu/README.md
          - Water Plant and OPC-UA: user/examples/opc-ua-waterplant/README.md
          - Three Water Tanks: user/examples/three-tank/README.md
          - Flex Cell: user/examples/flex-cell/README.md
          - Incubator: user/examples/incubator/README.md
          - Firefighters: user/examples/o5g/README.md
          - Mass Spring Damper with NuRV:
              user/examples/mass-spring-damper-monitor/README.md
          - Water Tank Fault Injection with NuRV:
              user/examples/water_tank_FI_monitor/README.md
          - Incubator Co-Sim with NuRV:
              user/examples/incubator-NuRV-monitor-validation/README.md
          - Incubator with NuRV Service:
              user/examples/incubator-NuRV-monitor-service/README.md
          - Incubator with NuRV FMU Service:
              user/examples/incubator-NuRV-fmu-monitor-service/README.md
          - Codebase: https://github.com/INTO-CPS-Association/DTaaS-examples
  - Admin:
      - Installation Scenarios:
          - Overview: admin/overview.md
          - Steps: admin/steps.md
      - DTaaS:
          - Localhost:
              - Install: admin/dtaas/localhost/install.md
              - Config: admin/dtaas/localhost/config.md
          - Secure Server:
              - Install: admin/dtaas/secure-server/install.md
              - Config: admin/dtaas/secure-server/config.md
          - Secure Server and GitLab:
              - Install: admin/dtaas/secure-server-gitlab/install.md
              - Config: admin/dtaas/secure-server-gitlab/config.md
          - CLI: admin/cli.md
      - Workspace:
          - Localhost:
              - Install: admin/workspace/localhost/install.md
              - Dex: admin/workspace/localhost/dex.md
              - Custom User: admin/workspace/localhost/custom-user.md
              - Developer: admin/workspace/localhost/developer.md
          - Secure Server:
              - Install: admin/workspace/secure-server/install.md
              - Configuration: admin/workspace/secure-server/configuration.md
              - Keycloak Setup: admin/workspace/secure-server/keycloak-setup.md
              - Design: admin/workspace/secure-server/design.md
      - Platform Services: admin/services/cli.md
      - GitLab:
          - Server: admin/gitlab/index.md
          - Integration: admin/gitlab/integration.md
          - Runner:
              - Linux: admin/gitlab/runner-linux.md
              - Windows: admin/gitlab/runner-windows.md
      - Independent Packages:
          - Listing: admin/packages.md
          - Workspace Packages: admin/workspace/index.md
          - Library Microservice:
              - NPM: admin/servers/lib/npm.md
              - Docker: admin/servers/lib/docker.md
      - Guides:
          - Localhost on Portainer:
              admin/guides/localhost-on-portainer/install.md
          - Check Config: admin/guides/check_config.md
          - Add user: admin/guides/add_user.md
          - Remove user: admin/guides/remove_user.md
          - Common Assets: admin/guides/common_workspace_readonly.md
          - Renew Certificates: admin/guides/renew_certs.md
  - FAQ: FAQ.md
  - Developer:
      - Guide:
          - Contributors: developer/index.md
      - System:
          - Architecture: developer/system/architecture.md
          - Current Status: developer/system/current-status.md
          - Research Overview: developer/system/research-overview.md
      - Technical Concepts:
          - OAuth 2.0 and Keycloak:
              developer/technical-concepts/oauth-keycloak.md
          - OAuth 2.0 Concepts:
              developer/technical-concepts/oauth/oauth2.0.md
          - Auth System Design: developer/technical-concepts/oauth/design.md
          - Auth Microservice: developer/technical-concepts/oauth/authms.md
          - DevOps: developer/technical-concepts/gitlab.md
          - Testing: developer/technical-concepts/testing.md
      - Codebase:
          - Client: developer/codebase/client.md
          - DevOps Framework: developer/codebase/devops.md
          - Client DevOps Integration: developer/codebase/client-devops.md
          - Library Microservice: developer/codebase/lib-ms.md
          - Runner Microservice: developer/codebase/runner.md
          - DTaaS CLI: developer/codebase/cli.md
          - DTaaS Services: developer/codebase/dtaas-services.md
          - Publish Packages: developer/codebase/publish-packages.md
      - Contributions:
          - Code of Conduct: developer/contributions/conduct.md
          - Copilot Instructions:
              developer/contributions/copilot-instructions.md
          - Local Testing: developer/contributions/local-testing.md
          - Docker Check: developer/contributions/docker.md
          - GitHub Actions: developer/contributions/github-actions.md
          - Publish NPM Packages: developer/contributions/npm-packages.md
          - Vagrant: developer/vagrant.md
  - Bugs: bugs.md
  - Thanks: thanks.md
  - License:
      - DTaaS: LICENSE.md
      - Third Party: third-party.md

use_directory_urls: false

extra_css:
  - assets/css/extra.css

extra_javascript:
  # yamllint disable-line rule:line-length
  - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js?config=TeX-AMS-MML_HTMLorMML
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      linenums: true
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - admonition
  - pymdownx.tabbed:
      alternate_style: true
  - mdx_math:
      enable_dollar_delimiter: True

plugins:
  - open-in-new-tab
  - search
  - with-pdf:
      author: "DTaaS Development Team"
      cover: true
      cover_logo: assets/dtaas-logo.png
      cover_subtitle: ""
      enabled_if_env: MKDOCS_ENABLE_PDF_EXPORT
      output_path: pdf/DTaaS-docs.pdf