kotlin-patterns/mkdocs.yml at master · AlexRogalskiy/kotlin-patterns · 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
site_name: Kotlin Patterns
site_description: >
  kotlin code patterns and basic architecture designing concepts
site_author: Alexander Rogalskiy
site_url: https://alexander-rogalsky.gitbook.io/kotlin-patterns/

repo_name: AlexRogalskiy/kotlin-patterns
repo_url: https://gitlab.com/AlexRogalskiy/kotlin-patterns
edit_uri: https://gitlab.com/AlexRogalskiy/kotlin-patterns/master/docs/

#Copyright (shown at the footer)
copyright: 'Copyright &copy; 2021 Nullables.io'

# Extra Files
extra_javascript:
  - assets/js/asciinema-player.js

extra_css:
  - assets/css/asciinema-player.css
  - assets/css/extra.css

# Theme
theme:
  name: material
  language: en
  highlightjs: true
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - tabs
    - navigation.top
    - navigation.tabs.sticky
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - search.suggest
    - search.highlight
    - header.autohide
    - toc.integrate
    - content.tabs.link
  palette:
    - media: '(prefers-color-scheme: light)'
      scheme: default
      primary: 'black'
      accent: 'grey'
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: '(prefers-color-scheme: dark)'
      scheme: slate
      primary: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  logo: assets/images/logos/logo.svg
  favicon: assets/images/favicons/favicon.ico
  icon:
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search
  - git-revision-date-localized: # https://squidfunk.github.io/mkdocs-material/plugins/revision-date/
      fallback_to_build_date: true
      type: date
  - awesome-pages # https://squidfunk.github.io/mkdocs-material/plugins/awesome-pages/
  - include-markdown # https://github.com/mondeja/mkdocs-include-markdown-plugin
#  - minify:
#      minify_html: true

# Extra
extra:
  generator: false
  social:
    - icon: fontawesome/brands/github-alt
      link: 'https://github.com/AlexRogalskiy/kotlin-patterns'
  version:
    provider: mike

# Extensions
markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 3
  - def_list: {}
  - footnotes: {}
  - tables: {}
  - meta: {}
  - admonition: {} # https://squidfunk.github.io/mkdocs-material/extensions/admonition/
  - codehilite: # https://squidfunk.github.io/mkdocs-material/extensions/codehilite/
      linenums: true
      use_pygments: false
      guess_lang: false
  - pymdownx.highlight: {}
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.extra: {}
  - pymdownx.tilde: {}
  - pymdownx.magiclink: {}
  - pymdownx.caret: {}
  - pymdownx.smartsymbols: {}
  - pymdownx.progressbar: {}
  - pymdownx.arithmatex: {}
  - pymdownx.mark: {}
  - pymdownx.critic: {}
  - pymdownx.inlinehilite: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#inlinehilite
  - pymdownx.superfences: # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#superfences
     custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.tabbed: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#tabbed
  - pymdownx.details: {} # https://squidfunk.github.io/mkdocs-material/extensions/pymdown/#details
  - pymdownx.emoji: # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/#configuration
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - smarty: {} # https://python-markdown.github.io/extensions/smarty/
  - nl2br: {} # https://python-markdown.github.io/extensions/smarty/
  - mdx_truly_sane_lists: {} # https://github.com/radude/mdx_truly_sane_lists -> proper indentation of md list items
  - markdown.extensions.attr_list: {}

# Other Settings
strict: false # halt processing when a warning is raised