code-realtime/mkdocs.yml at main · secure-dev-ops/code-realtime · 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
#Project Information
site_name: DevOps Code RealTime
site_description: >-
  Code RealTime is an extension for Visual Studio Code and Eclipse Theia for creating stateful realtime C++ applications consisting of communicating state machines.
site_url: https://secure-dev-ops.github.io/code-realtime/

#Md and HTML locations in the repository
site_dir: docs
docs_dir: docs-sources

# Theme Configuration
theme:
  name: material
  logo: assets/logo.png
  favicon: assets/favicon.png
  language: en
  features:
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.share
    - search.suggest
    - announce.dismiss
  custom_dir: theme_overrides/
  icon:
    repo: fontawesome/brands/github
  font:
    text: Roboto
    code: Roboto Mono

  # Static files
  static_templates:
    - 404.html


# Markdown Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
#  - pymdownx.superfences
  - pymdownx.keys
  - attr_list
  - footnotes
  - sane_lists

extra:
#  analytics:
#    provider: custom
#    property: UA-169645537-2
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/secure-dev-ops/code-realtime
  version:
    provider: mike


copyright: >-
  <p> Copyright &copy; 2022, 2025 HCL Technologies Ltd. IBM Corporation. All Rights Reserved.</p>

# Repository
repo_url: https://github.com/secure-dev-ops/code-realtime
repo_name: secure-dev-ops/code-realtime
edit_uri: edit/main/docs-sources


# Customization
extra_css:
  - stylesheets/style.css
  - stylesheets/prism.css

extra_javascript:
  - scripts/prism.js

plugins:
  - search
  - markdownextradata:
      data: variables
      jinja_options:
          variable_start_string: '{$'
          variable_end_string: '$}'

extra:
  product:
    name: Code RealTime
  rtist:
    name: Model RealTime

 #Table of contents
nav:
  - Home: index.md
  - Documentation:
     - Overview: overview.md
     - Installing: installing.md
     - The Art Language:
        - The Art Language: art-lang/index.md
        - C++ Extensions: art-lang/cpp-extensions.md
     - Working with Art:
        - Working with Art: working-with-art/index.md
        - Text Editor: working-with-art/art-editor.md
        - Diagrams: working-with-art/diagrams.md
        - Outline View: working-with-art/outline-view.md
        - References View: working-with-art/references.md
     - Validation: validation.md
     - Target RunTime System:
        - Target RunTime System: target-rts/index.md
        - Timers: target-rts/timers.md
        - Threads: target-rts/threads.md
        - Message Communication: target-rts/message-communication.md
        - Logging: target-rts/logging.md
        - Integration with External Code: target-rts/integrate-with-external-code.md
        - Capsule Factory: target-rts/capsule-factory.md
        - Dependency Injection: target-rts/dependency-injection.md
        - Encoding and Decoding: target-rts/encoding-decoding.md
        - Building, Debugging and Customizing: target-rts/build.md
        - Versions: target-rts/versions.md
        - C++ API: targetrts-api/index.html
     - Building:
        - Building: building/index.md
        - Transformation Configurations: building/transformation-configurations.md
        - C++ Source Files: building/build-cpp-files.md
        - Build Tasks: building/build-tasks.md
        - Art Compiler: building/art-compiler.md
        - Build Variants: building/build-variants.md
     - Running and Debugging:
        - Running and Debugging: running-and-debugging/index.md
        - Launch Configurations: running-and-debugging/launch-configurations.md
        - Art Debugger: running-and-debugging/debugging.md
        - RTS Debugger: running-and-debugging/rts-debugger.md
        - Tracing: running-and-debugging/tracing.md
     - Releases:
        - Releases: releases/index.md
     - Settings: settings.md
     - Support Procedures: support.md
     - Learning:
        - Learning: learning/index.md
        - Art Tutorial: learning/art-tutorial.md
     - Contributing: contributing.md
  - Samples: samples.md
  - Forum: https://github.com/secure-dev-ops/code-realtime/discussions
  - Videos: https://www.youtube.com/playlist?list=PLErYHbqUeWuB4lExh9K64uS1wxgvv9dmh