docs/mkdocs.yml at main · dcc-bigfred/docs · 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
site_name: BigFred
site_url: https://dcc-bigfred.github.io/docs/
repo_url: https://github.com/dcc-bigfred/docs
repo_name: dcc-bigfred/docs
edit_uri: edit/main/content/en/

docs_dir: content
exclude_docs: |
  LICENSE

theme:
  name: landing
  custom_dir: overrides

  favicon: assets/avatar.svg
  avatar: assets/avatar.svg
  tagline: |
    Modern, multi-user DCC driver supporting LocoNet and Z21
  footer: |
    Compiled from markdown using [MkDocs](https://www.mkdocs.org/). Theme is
    [Landing](https://teparsons.github.io/mkdocs-landing/) by
    [Todd Parsons](https://toddparsons.co.uk).
  page_source:
    link: https://github.com/dcc-bigfred/docs
    icon: [brands, github]
  socials:
    - label: GitHub
      link: https://github.com/dcc-bigfred
      icon: [brands, github]

  header_layout:
    - title
    - tagline
  share_btn: false
  content_box_opacity: 0
  avatar_size: 8rem
  round_avatar: true
  background_gradient_colors:
    - color-mix(in srgb, var(--crust) 100%, transparent)
    - color-mix(in srgb, var(--base) 80%, transparent)

  primary_color: "#dd7878"
  secondary_color: "#7287fd"
  tertiary_color: "#dd7878"
  base_color: "#24273a"
  mantle_color: "#1e2030"
  crust_color: "#181926"
  overlay_color: "#9B9B9E"
  text_color: "#c6d0f5"
  hltext_color: "#24273a"

  primary_color_dark: "#dd7878"
  secondary_color_dark: "#7287fd"
  tertiary_color_dark: "#dd7878"
  base_color_dark: "#24273a"
  mantle_color_dark: "#1e2030"
  crust_color_dark: "#181926"
  overlay_color_dark: "#9B9B9E"
  text_color_dark: "#c6d0f5"
  hltext_color_dark: "#24273a"

  body_font: Maven Pro
  heading_font: Oswald

extra:
  languages:
    en: English
    pl: Polski

extra_css:
  - assets/expanded-toc.css

plugins:
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: pl
          name: Polski
          build: true
          nav_translations:
            Home: Strona główna
            User guide: Przewodnik użytkownika
            Related: Powiązane
            Specifications: Specyfikacja
            Overview: Przegląd
            Locomotives and trains: Lokomotywy i składy
            Remotes: Piloty
  - search
  - awesome-pages
  - mermaid2

markdown_extensions:
  - tables
  - admonition
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - toc