hexkit/mkdocs.yml at main · ghga-de/hexkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
site_name: Hexkit Documentation
site_description: Comprehensive documentation for the hexkit library
site_url: https://ghga-de.github.io/hexkit/

theme:
  name: readthedocs
  highlightjs: true
  hljs_languages:
    - python
    - yaml
    - json
    - bash

nav:
  - Home: index.md
  - Architectural Concepts:
    - arch_concepts/overview.md
    - Hexagonal Architecture: arch_concepts/hexagonal_arch.md
    - Triple Hexagonal Architecture: arch_concepts/triple_hexagonal_arch.md
    - Event-Driven Architecture: arch_concepts/event_driven_arch.md
    - Dead Letter Queue: arch_concepts/dlq.md
  - Protocols:
    - protocols/overview.md
  - Providers:
    - providers/overview.md
    - Kafka:
      - providers/kafka/publisher.md
      - providers/kafka/subscriber.md
      - providers/kafka/test_utils.md
    - MongoDB:
      - providers/mongodb/dao.md
      - providers/mongodb/migration_tools.md
      - providers/mongodb/test_utils.md
    - MongoKafka:
      - providers/mongokafka/outbox_pub.md
      - providers/mongokafka/persistent_publisher.md
    - S3:
      - providers/s3/overview.md
      - providers/s3/test_utils.md
  - Observability Tools:
    - observability_tools/overview.md
    - observability_tools/correlation_ids.md
    - observability_tools/logging.md
  - Developer Help:
    - developer_help/overview.md
    - developer_help/testing.md
    - developer_help/outbox_v_persistent_pub.md
  - Structure:
    - structure/overview.md
  - API Reference:
    - api/index.md
  - Glossary:
    - glossary/index.md

markdown_extensions:
  - admonition
  - codehilite:
      guess_lang: false
  - toc:
      permalink: true
  - tables
  - fenced_code

plugins:
  - search