voltscript-voltmx-middleware/mkdocs.yml at main · HCL-TECH-SOFTWARE/voltscript-voltmx-middleware · 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
site_name: VoltScript Volt MX Middleware
site_url: https://github.com/pages/HCL_TECH_SOFTWARE/voltscript-voltmx-middleware/
site_description: >-
  VoltScript Volt MX Middleware: Middleware libraries for Volt MX Foundry integration services
use_directory_urls: false
# Theme Configuration
theme:
  name: material
  logo: assets/images/VoltMXGoLogo.png
  language: en
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.share
    - search.suggest
    - content.code.annotate
    - content.code.copy
    - content.tooltips
  custom_dir: theme_overrides/
  icon:
    repo: fontawesome/brands/github
  font: false
  #  text: Roboto
  #  code: Roboto Mono
  favicon: assets/images/favicon.png
#  palette:
#    - scheme: default
#      primary: indigo
#      accent: indigo
#      toggle:
#        icon: material/brightness-7
#        name: Switch to dark mode
#    - scheme: slate
#      primary: indigo
#      accent: indigo
#      toggle:
#        icon: material/brightness-4
#        name: Switch to light mode

  # Static files
  static_templates:
    - 404.html

# Markdown Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - md_in_html
  - abbr
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path:
        - "docs/.snippets"
  - toc:
     title: On this page

# Copyright
copyright: >-
  Copyright &copy; 2024-2025, HCL America, Inc. | <a href="https://www.hcl-software.com/legal/privacy" target="_blank">Privacy Statement</a> | <a href="https://www.hcl-software.com/legal/terms-use" target="_blank">Terms of Use</a> <br/>
  <a href="#__consent">Change cookie settings</a>

extra:
  productversion: 1.0.3
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/HCL-TECH-SOFTWARE
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    actions:
      - accept
      - manage

# Repository
repo_url: https://github.com/HCL-TECH-SOFTWARE/voltscript-voltmx-middleware/
repo_name: HCL-TECH-SOFTWARE/voltscript-voltmx-middleware
edit_uri: edit/main/docs

# Customization
extra_css:
  - assets/css/style.css
  - assets/css/style1.css

plugins:
  - awesome-pages
  - search
  - tags