faststream-outbox/mkdocs.yml at main · modern-python/faststream-outbox · 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
site_name: faststream-outbox
site_url: https://faststream-outbox.modern-python.org/
repo_url: https://github.com/modern-python/faststream-outbox
docs_dir: docs
edit_uri: edit/main/docs/
nav:
  - Overview: index.md
  - Getting started:
      - Installation: introduction/installation.md
      - Basic usage: usage/basic.md
      - 'Tutorial: Your first outbox app': tutorials/first-outbox-app.md
      - 'Tutorial: Add a Kafka relay': tutorials/add-kafka-relay.md
  - Concepts:
      - How it works: introduction/how-it-works.md
      - Performance: concepts/performance.md
      - Comparison: concepts/comparison.md
      - Instrumentation seams: concepts/instrumentation-seams.md
  - Guides:
      - FastAPI integration: usage/fastapi.md
      - Relay to Kafka / RabbitMQ / NATS: usage/relay.md
      - Timers: usage/timers.md
      - Testing: usage/testing.md
      - Schema validation: usage/schema-validation.md
      - Setup Prometheus and OpenTelemetry: usage/setup-prometheus-opentelemetry.md
      - 'A messaging service, end-to-end': usage/messaging-service.md
  - Reference:
      - Subscriber: usage/subscriber.md
      - Publisher: usage/publisher.md
      - Router: usage/router.md
      - Dead-letter queue: usage/dlq.md
      - Observability: usage/observability.md
  - Operations:
      - Production checklist: operations/checklist.md
      - Troubleshooting: operations/troubleshooting.md
      - Alembic migrations: operations/alembic.md
theme:
  name: material
  custom_dir: overrides
  logo: assets/mark.svg
  favicon: assets/favicon.svg
  features:
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - navigation.footer
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.instant
    - header.autohide
    - announce.dismiss
  icon:
    edit: material/pencil
    view: material/eye
    repo: fontawesome/brands/git-alt
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - def_list
  - codehilite:
      use_pygments: true
  - attr_list
  - md_in_html

extra_css:
  - css/code.css
  - css/brand.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/modern-python/faststream-outbox
      name: GitHub