mkdocs.yml

site_name: Platforms, Microservices, DevOps and APIs
site_author: Sandmann, H.
site_url: https://insper.github.io/platform
repo_url: https://github.com/insper/platform

theme:
  name: material
  palette:
    # primary: grey
    # Light mode
    - scheme: default
      primary: grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default 
      primary: grey
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: grey
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to system preference
  features:
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    - navigation.path
    - navigation.tracking
  icon:
    # logo: assets/images/devops
    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
  logo: assets/images/devops.png

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - markdown_grid_tables:
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji 
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true  
  - footnotes
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - tables


plugins:
  - glightbox
  - git-revision-date-localized:
      enable_creation_date: true
  - git-authors
  - git-committers:
      repository: hsandmann/hsandmann.github.com
      branch: main
  - search
  - badges
  - markdown-exec
  - render_swagger:
      allow_arbitrary_locations : true
  - termynal:
      prompt_literal_start:
        - "$"
        - ">"

extra_javascript:
  - assets/javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - assets/stylesheets/extra.css

nav:
  - Home: index.md
  - 2025.1: versions/2025.1.md
  - Checkpoints:
    - 1. CRUD Spring Boot: checkpoints/checkpoint1.md
    - 2. Gateway Spring Cloud: checkpoints/checkpoint2.md
    - 3. Security Spring Cloud: checkpoints/checkpoint3.md
    - 4. DevOps: checkpoints/checkpoint4.md
    - 5. Kubernetes: checkpoints/checkpoint5.md
  - Concepts:
    - Microservices: concepts/microservices.md
    - Architectures: concepts/architectures.md
  - Versions:
    - 2025.1: ./versions/2025.1.md
    - 2024.1: ./versions/2024.1.md
  # - Handout:
  #   - Microservices:
  #     - Roadmap: ./handout/microservices/roadmap.md
  #     - Account: ./handout/microservices/account.md
  #     - Auth: ./handout/microservices/auth.md
  #     - Discovery: ./handout/microservices/discovery.md
  #     - Gateway: ./handout/microservices/gateway.md
  #   - DevOps:
  #     - Observability: ./handout/devops/observability.md
  #   #   - Roadmap: ./handout/devops-roadmap.md
  #     - Jenkins: ./handout/devops/jenkins.md
  #   #   - Docker: ./handout/devops-docker.md
  #     - Kubernetes: ./handout/devops/kubernetes.md
  #   - Cloud:
  #     - AWS:
  #       - cli: ./handout/cloud/aws/cli.md
  #       - eks: ./handout/cloud/aws/eks.md
  #   - Architecture: ./handout/architecture.md
  #   - Business: ./handout/business.md
  # - API:
  #   - Spring Boot Cloud: ./api/spring-boot-cloud.md
  #   - Testing: ./api/testing.md
  #   - Documentation: ./api/documentation.md
  # - Platform:
  #   - Concepts: ./platform/concepts.md
  #   - Microservices: ./platform/microservices.md
  #   - Discovery: ./platform/discovery.md
  #   - Gateway: ./platform/gateway.md
  #   - Config: ./platform/config.md
  #   - Load Balancing: ./platform/load-balancing.md
  #   - Circuit Breaker: ./platform/circuit-breaker.md
  #   - Security:
  #     - Concepts: ./platform/security/concepts.md
  #     - JWT: ./platform/security/jwt.md
  #     - OAuth2: ./platform/security/oauth2.md
  #     # - Auth Service: ./platform/security/auth-service.md
  #     # - OpenID: openid.md
  #     # - SSO: sso.md
  #   - Communication: ./platform/communcation.md
  #   - Observability:
  #     - Monitoring: ./platform/observability/monitoring.md
  #     - Logging: ./platform/observability/logging.md
  #     - Tracing: ./platform/observability/tracing.md
  #   - Messaging: 
  #     - Concepts: ./platform/messaging/concepts.md
  #     - Kafka: ./platform/messaging/kafka.md
  #     - RabbitMQ: ./platform/messaging/rabbitmq.md
  #   - Database:
  #     - Flyway: ./platform/database/flyway.md
  #     - Caching: ./platform/database/caching.md
  #     # - MongoDB: mongodb.md
  #     # - Elasticsearch: elasticsearch.md
  #   - Payment: ./platform/payment.md
  # - DevOps:
  #   - Concepts: ./devops/concepts.md
  #   - Version Control: ./devops/version-control-system.md
  #   - Docker: ./devops/docker.md
  #   - Packaging: ./devops/packaging.md
  #   - Release: ./devops/release.md
  #   # - Nexus: nexus.md
  #   # - SonarQube: sonarqube.md
  #   - Kubernetes: ./devops/kubernetes.md
  # - Cloud Computing:
  #   - AWS: ./cloud/aws.md
  #   - GCP: ./cloud/gcp.md
  #   - Azure: ./cloud/azure.md
  #   - GitActions: ./cloud/gitactions.md
  #   - Terraform: ./cloud/terraform.md
  # - Business:
  #   - Concepts: ./business/concepts.md
  - Appendix:
    - REST vs GraphQL: ./appendix/rest-vs-graphql.md
    - Versioning REST APIs: ./appendix/versioning-rest-apis.md
    - TLS for microservices: ./appendix/tls-for-microservices.md
    - RSA Algorithm: ./appendix/rsa.md
    - Oh My Zsh: ./appendix/ohmyzsh.md
    - Others: ./appendix/others.md
  - Disclaimer: ./disclaimer.md