use-case-tree-method/mkdocs.yml at main · obkhan/use-case-tree-method · 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
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: Use Case Tree Method
site_description: Use Case Tree Method
repo_name: 'EKGF/use-case-tree-method'
repo_url: https://github.com/EKGF/use-case-tree-method
site_url: https://use-case-tree-method.ekgf.org
site_dir: site
site_author: Enterprise Knowledge Graph Foundation
copyright: Copyright &copy; 2022 Enterprise Knowledge Graph Foundation & agnos.ai UK Ltd
edit_uri: ''
# Navigation
# nav: omitted, because we're using the awesome-pages plugin (https://squidfunk.github.io/mkdocs-material/plugins/awesome-pages/)
extra_css:
  - stylesheets/extra.css
theme:
  name: material
  language: en
  custom_dir: docs-overrides/
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: ekgf-logo-symbol
    repo: fontawesome/brands/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: light-blue
      toggle:
#        icon: material/toggle-switch-off-outline
#        icon: material/lightbulb-outline
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: deep orange
      toggle:
#        icon: material/toggle-switch
#        icon: material/lightbulb
        icon: material/weather-night
        name: Switch to light mode
  features:
    - search.highlight
    - navigation.top
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
#    - navigation.sections
#    - navigation.expand
    - navigation.indexes
    - toc.follow
    - toc.integrate
    - content.code.annotate
extra:
  generator: false
  giscus:
    repo_id: 'R_kgDOGyFarg'
    category:
      name: 'General'
      id: 'DIC_kwDOGyFars4CA_Gc'
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/EKG_Foundation
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/EKGF
    - icon: fontawesome/brands/github
      link: https://github.com/EKGF/ekg-catalog
  analytics:
    provider: google
    property: G-VSE38KT025
extra_javascript:
  - "javascript/images_dark.js"
  - "javascript/refresh_on_toggle_dark_light.js"
  - "https://cdn.jsdelivr.net/gh/rod2ik/cdn@main/mkdocs/javascripts/mkdocs-graphviz.js"
plugins:
  - search:
      lang:
        - en
  - include-markdown
  - git-revision-date
  - exclude:
      glob:
        - "*.tmp"
        - "*.sparql"
        - "*.gz"
        - diagrams/src/*
      regex:
        - '.*\.(tmp|bin|tar)$'
        - '_.*\.md$'
  - build_plantuml:
      render: "server" # or "local" for local rendering
      bin_path: "/usr/local/bin/plantuml" # ignored when render: server
      server: "http://www.plantuml.com/plantuml" # offical plantuml server
      output_format: "svg" # or "png"
      diagram_root: "docs/diagrams" # should reside under docs_dir
      output_folder: "out"
      input_folder: "src"
      input_extensions: "" # comma separated list of extensions to parse, by default every file is parsed
      theme_enabled: true
      theme_folder: "include/themes"
      theme_light: "light.puml"
      theme_dark: "dark.puml"
  - awesome-pages:
      filename: .pages.yaml
      collapse_single_pages: false
      strict: true
  - macros:
      module_name: docs/main

markdown_extensions:
  - toc:
      permalink: true
  - meta
  - mdx_spanner
  - def_list
  - abbr
  - admonition
  - mdx_emdash
  - attr_list
  - footnotes
  - tables
  - md_in_html
  - mkdocs_graphviz
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path:
        - .
        - docs
      check_paths: true
      auto_append:
        - abbreviations.md
  - pymdownx.details
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - 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