transmission/mkdocs.yml at main · Trendyol/transmission · 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
site_name: Transmission
repo_name: Transmission
site_description: "Experimental asynchronous communication for Business Logic"
site_author: Trendyol
repo_url: https://github.com/trendyol/transmission
remote_branch: gh-pages
site_dir: build/site

copyright: 'Copyright &copy; 2024 Trendyol'

markdown_extensions:
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - admonition
  - abbr
  - tables

plugins:
  - search

theme:
  name: material
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: 'white'
      accent: 'orange'
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: 'black'
      accent: 'yellow'
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: 'Lato'
    code: 'Fira Code'

  features:
  - content.code.copy
  - content.code.select
  - content.code.annotate
  - content.tabs.link
  - content.tooltips
  - header.autohide
  - navigation.top
  - navigation.tracking
  - navigation.sections
  - navigation.indexes
  - navigation.footer
  - search.highlight
  - search.share
  - search.suggest
  - toc.integrate

extra:
  # External API documentation link
  api_docs_url: "api/0.x/"

nav:
  - 'Introduction': index.md
  - 'How To Use': 'how_to_use.md'
  - 'Setting Up': 'setup.md'
  - 'Transmissions': 'transmissions.md'
  - 'Transformer': 'transformer.md'
  - 'TransmissionRouter': 'router.md'
  - 'DataHolder': 'dataholder.md'
  - 'Handlers': 'handlers.md'
  - 'Contracts': 'contracts.md'
  - 'Transformer Communication': 'transformer_communication.md'
  - 'Testing': 'testing.md'
  - 'Changelog': 'changelog.md'
  # - 'Roadmap': 'roadmap.md'