WebSocketClient/mkdocs.yml at main · Dyalog/WebSocketClient · 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
site_name: WebSocketClient
repo_url: https://github.com/dyalog/websocketclient
repo_name: Dyalog/WebSocketClient
dev_addr: 127.0.0.1:22222
copyright: <div class="left">Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"><strong>Material for MkDocs</strong></a>.&nbsp;</div><div class="right">Contents copyright &copy;2015-2026 <strong><a href="https://dyalog.com" target="_blank" rel="noopener">Dyalog, LTD</a></strong></div>
nav:
  - Overview: "index.md"
  - "Usage Guide": "userguide.md"
  - "Troubleshooting": "troubleshooting.md"
  - "Advanced Usage":
      - "Partial Messages": "partial.md"
      - "Secure Connections": "secure.md"
      - "Conga Usage": "conga.md"
      - "Headers and Authentication": "authentication.md"
      - "Connecting Through a Proxy": "proxy.md"
  - Reference:
      - "Settings":
          - "Connect-related settings": "settings-connect.md" # complete
          - "Proxy-related settings": "settings-proxy.md" # complete
          - "Conga-related settings": "settings-conga.md" # complete
          - "Event Hook settings": "settings-eventhooks.md"
          - "WebSocket-specific settings": "settings-websocket.md" # complete
          - "Status-related settings": "settings-status.md" # complete
      - "Public Methods": "public-methods.md"
  - About:
      - License: "license.md"
      - "Release Notes": "release-notes.md"

theme:
  favicon: "img/favicon-32.png"
  logo: "img/dyalog-white.svg"
  features:
    - navigation.sections
    - navigation.instant
  name: material

extra:
  generator: false
  version:
    provider: mike

extra_css:
  - css/main.css

plugins:
  - search
  - print-site:
      add_to_navigation: true
      print_page_title: "Print"
      add_print_site_banner: false
      # Table of contents
      add_table_of_contents: false
      toc_title: "Table of Contents"
      toc_depth: 6
      # Content-related
      add_full_urls: false
      enumerate_headings: false
      enumerate_figures: false
      add_cover_page: true
      cover_page_template: ""
      path_to_pdf: ""
      include_css: true
      enabled: true
      exclude:

markdown_extensions:
  - admonition
  - abbr
  - footnotes
  - attr_list
  - def_list
  - markdown_tables_extended
  - pymdownx.tilde
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      title: On this page