SharedComponents/mkdocs.yml at master · tailored-apps/SharedComponents · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
# Project information
site_name: "Tailored Apps. .NET Shared Components"
site_description: "Reusable components for webapps"
site_author: "Tailored Apps."
site_url: "https://shared.tailoredapps.pl/"

# Copyright
copyright: "&copy; 2022 Tailored Apps"

# Repository
repo_name: "SharedComponents"
repo_url: "https://github.com/tailored-apps/SharedComponents"
edit_uri: "https://github.com/tailored-apps/SharedComponents/edit/master/docs"

# Configuration
docs_dir: "docs"
extra_css:
  - stylesheets/extra.css

# Navigation
nav:
  - Home: index.md
  - Libraries:
      - DateTime: Libraries/DateTime/index.md
      - Email:
          - Overview: Libraries/Email/index.md
          - Models: Libraries/Email/Models.md
          - Office365: Libraries/Email/Office365.md
      - EntityFramework:
          - Overview: Libraries/EntityFramework/index.md
          - UnitOfWork.WebApiCore: Libraries/EntityFramework/UnitOfWork.WebApiCore.md
      - ExceptionHandling: Libraries/ExceptionHandling/index.md
      - MediatR:
          - Overview: Libraries/MediatR/index.md
          - Caching: Libraries/MediatR/Caching.md
          - Email: Libraries/MediatR/Email.md
          - ML: Libraries/MediatR/ML.md
          - PagedRequest: Libraries/MediatR/PagedRequest.md
      - Payments:
          - Overview: Libraries/Payments/index.md
          - Providers:
              - Adyen: Libraries/Payments/Providers/Adyen.md
              - CashBill: Libraries/Payments/Providers/CashBill.md
              - HotPay: Libraries/Payments/Providers/HotPay.md
              - PayNow: Libraries/Payments/Providers/PayNow.md
              - PayU: Libraries/Payments/Providers/PayU.md
              - Przelewy24: Libraries/Payments/Providers/Przelewy24.md
              - Revolut: Libraries/Payments/Providers/Revolut.md
              - Stripe: Libraries/Payments/Providers/Stripe.md
              - Tpay: Libraries/Payments/Providers/Tpay.md
      - Querying: Libraries/Querying/index.md
  - Contributing: contributing.md
  - Changelog: Libraries/Readme.md

# Configuration
theme:
  name: material
  language: pl
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Hooks
#hooks:
#  - material/.overrides/hooks/translations.py

# Customization
extra:
  annotate:
    json: [.s2]
  analytics:
    provider: google
    property: GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tailored-apps/SharedComponents
  alternate:
    - name: Polski
      link: /
      lang: pl
    - name: English
      link: /en/
      lang: en
  alternate:
    - name: Polski
      link: /
      lang: pl
    - name: English
      link: /en/
      lang: en

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - 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
  - pymdownx.tilde