umltheme/mkdocs.yml at main · doubleSlashde/umltheme · 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
# MkDocs configuration for GitHub Pages.
# Published via .github/workflows/docs.yml when pushes land on main.

site_name: plantUML Theme User Guide
site_description: >-
  doubleSlash PlantUML themes — gen2 styling, diagram support, MkDocs integration
site_author: doubleSlash
site_url: https://doubleslashde.github.io/umltheme/

repo_name: doubleSlashde/umltheme
repo_url: https://github.com/doubleSlashde/umltheme
edit_uri: edit/main/docs/

docs_dir: docs
site_dir: site

extra_css:
  - assets/style-guide/color-tokens.css

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.expand
    - content.code.copy
    - content.action.edit

markdown_extensions:
  - toc:
      permalink: true
      toc_depth: 2
  - md_in_html
  - tables
  - admonition
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.snippets:
      base_path: docs
      check_paths: true
  - pymdownx.details:
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search
  - plantuml:
      puml_url: https://www.plantuml.com/plantuml/
      puml_keyword: puml
      verbose: false

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Theme usage: theme-usage.md
  - Examples & diagram types: examples.md
  - Style Guide:
      - style-guide/index.md
      - Executive Summary: style-guide/executive-summary.md
      - Design Tokens: style-guide/design-tokens.md
      - Globale Defaults: style-guide/global-defaults.md
      - Diagrammtypen:
          - Sequence: style-guide/diagram-types/sequence.md
          - Class & Data: style-guide/diagram-types/class-and-data.md
          - Use Case: style-guide/diagram-types/use-case.md
          - Activity: style-guide/diagram-types/activity.md
          - State: style-guide/diagram-types/state.md
          - System & C4: style-guide/diagram-types/system-c4.md
          - Gantt: style-guide/diagram-types/gantt.md
          - Mindmap & WBS: style-guide/diagram-types/mindmap-wbs.md
          - Deployment & Component: style-guide/diagram-types/deployment-component.md
          - JSON, YAML & Misc: style-guide/diagram-types/data-and-misc.md
      - Autoren-Regeln: style-guide/authoring-rules.md
      - Theme-Entwicklung: style-guide/theme-development.md
      - Barrierefreiheit: style-guide/accessibility.md
      - Versionierung: style-guide/versioning.md
      - Beispiel-Galerie: style-guide/examples-gallery.md
      - Anti-Patterns: style-guide/anti-patterns.md