docs/mkdocs.yml at main · hypnogaba/docs · 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
site_name: Malbec Labs
site_url: https://docs.malbeclabs.com/
site_description: >-
  Documentation for connecting to and operating on the Malbec Labs / DoubleZero
  network — validator and tenant setup, multicast, rewards, geolocation, and
  contributor operations.
theme:
  name: material
  custom_dir: overrides
  logo: logo.svg
  favicon: favicon.svg
  # Language selector icon (sized to match theme/search controls)
  icon:
    alternate: material/translate
  palette:
    # Dark is the default (first entry). Toggle appears in the header.
    - scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - scheme: default
      primary: white
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.copy
    - navigation.indexes
    - navigation.tracking
plugins:
  - search
  # NOTE: llms.txt / llms-full.txt are generated by hooks/emit_markdown.py
  # from this nav (default/English locale). Keep pages you want indexed in nav.
  # The mkdocs-llmstxt plugin does not support mkdocs-static-i18n (it cannot
  # resolve localized page URIs), so we build them ourselves.
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 中文
          build: true
        - locale: ja
          name: 日本語
          build: true
        - locale: ko
          name: 한국어
          build: true
        - locale: pt
          name: Português
          build: true
        - locale: es
          name: Español
          build: true
        - locale: fr
          name: Français
          build: true
        - locale: it
          name: Italiano
          build: true
  # Must come after i18n (uses the locale that plugin injects).
  - git-revision-date-localized:
      type: date
      fallback_to_build_date: true
nav:
  - Welcome: index.md
  - Setup: setup.md
  - Runbooks:
    - Overview: runbooks/index.md
    - Install client: runbooks/install-client.md
    - Connect validator (IBRL Mainnet): runbooks/solana-ibrl-mainnet.md
    - Connect validator (IBRL Testnet): runbooks/solana-ibrl-testnet.md
    - Publish shreds (Edge): runbooks/publish-edge-shreds.md
    - Subscribe to shreds (Edge): runbooks/subscribe-edge-shreds.md
    - Permissioned / RPC: runbooks/permissioned-rpc.md
    - Other multicast: runbooks/other-multicast.md
    - Troubleshoot Edge: runbooks/troubleshoot-edge.md
  - Solana on DoubleZero:
    - Connect validator (IBRL Mainnet): DZ Mainnet-beta Connection.md
    - Connect validator (IBRL Testnet): DZ Testnet Connection.md
    - Publish shreds (Edge): Validator Multicast Connection.md
    - Subscribe to shreds (Edge): Edge Subscriber Connection.md
    - RPC / permissioned: Permissioned Connection.md
    - Validator rewards: Validator Rewards.md
    - Other multicast feeds: Other Multicast Connection.md
    - Troubleshooting: troubleshooting.md
  - Other tenants:
    - Overview: tenant.md
    - Shelby (Testnet): Shelby Permissioned Connection.md
    - New tenant: New Tenant.md
  - Contributors:
    - Overview: contribute-overview.md
    - Requirements & Architecture: contribute.md
    - Device Provisioning: contribute-provisioning.md
    - Operations: contribute-operations.md
    - OPS Management: contribute-ops-management.md
    - Geolocation: contribute-geolocation.md
    - Decommissioning: contribute-decommission.md
  - Reference:
    - Architecture: architecture.md
    - Geolocation: geolocation.md
    - Glossary: glossary.md
  - Support: support.md
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.caret
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - attr_list
  - md_in_html
  - pymdownx.blocks.caption
  - pymdownx.arithmatex:
      generic: true
  - toc:
      title: On this page
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - javascripts/cloudsmith-versions.js
  - javascripts/page-toolbar.js
  - javascripts/runbook-assist.js
  - javascripts/nav-accordion.js
  - javascripts/toc-page-top.js
  - javascripts/header-controls-order.js
  - javascripts/language-selector-label.js
  - javascripts/search-language-filter.js
  - javascripts/mathjax.js
  - path: https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
hooks:
  - hooks/emit_markdown.py
  - hooks/emit_well_known.py