config-mate/mkdocs.yaml at main · Terradue/config-mate · 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
site_name: Config Mate
# site_url: not available
site_author: Fabrice Brito, Simone Tripodi
repo_url: https://git.terradue.com/scoop/config-mate/
repo_name: scoop/config-mate

theme:
  logo: imgs/icon-eoap.png
  name: readthedocs

  palette:
  - media: "(prefers-color-scheme: light)"
    scheme: default
    toggle:
      icon: material/toggle-switch-off-outline
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    toggle:
      icon: material/toggle-switch
      name: Switch to light mode

plugins:
  - search
  - mermaid2:
      version: 11.4.1
  - build_plantuml:
      render: 'server' # or "local" for local rendering
      disable_ssl_certificate_validation: true # for self-signed and invalid certs
      output_format: 'svg'
      allow_multiple_roots: false
      diagram_root: 'docs/diagrams'
      input_folder: 'src'
      output_folder: '.'
      theme_enabled: true
      theme_folder: "include/themes"
      theme_light: "light.puml"
      theme_dark: "dark.puml"

markdown_extensions:
  - pymdownx.details
  - abbr
  - admonition
  - footnotes
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - attr_list
  - pymdownx.snippets:
      base_path: './'
  - pymdownx.highlight:
      line_spans: __span

extra_css:
  - styles/css/app.css

extra_javascript:
  - javascripts/config.js
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Tutorials:
    - Bundle your first configuration: tutorials/first-bundle.md
  - How-to guides:
    - Build a modular configuration: how-to/modular-configuration.md
    - Use the playground: how-to/playground.md
  - Reference:
    - CLI: reference/cli.md
    - JSON Reference ($ref): reference/json-reference.md
  - Explanation:
    - Why modular configuration?: explanation/modular-configuration.md
    - How the implementation is organized: explanation/implementation.md

copyright: <a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%20License%202.0-blue"" alt="Apache License, Version 2.0" /></a>