docs/mkdocs.yml at main · malbeclabs/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
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.png
  favicon: favicon.ico
  # Use a language-style globe icon for the language selector
  icon:
    alternate: fontawesome/solid/language
  palette:
    scheme: slate
    primary: grey
    accent: custom
  features:
    - content.code.copy
    - navigation.indexes
    - toc.integrate
    - header.autohide
plugins:
  - search
  # NOTE: llms.txt / llms-full.txt are generated by hooks/emit_markdown.py.
  # The mkdocs-llmstxt plugin does not support mkdocs-static-i18n (it cannot
  # resolve localized page URIs), so we build them ourselves from the default
  # (English) locale.
  - 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
nav:
  - Welcome: index.md
  - Quick Connect: quick-connect.md
  - Users:
    - Setup: setup.md
    - Tenants:
      - Overview: tenant.md
      - Solana:
        - Validator Mainnet-Beta Connection: DZ Mainnet-beta Connection.md
        - Validator Testnet Connection: DZ Testnet Connection.md
        - Permissioned Connection: Permissioned Connection.md
        - Validator Multicast Connection: Validator Multicast Connection.md
        - Validator Rewards: Validator Rewards.md
        - Other Multicast Connection: Other Multicast Connection.md
        - Edge Subscriber Connection: Edge Subscriber Connection.md
        - Troubleshooting: troubleshooting.md
      - Shelby:
        - Shelby Connection: Shelby Permissioned Connection.md
      - New Tenant: New Tenant.md
    - Geolocation: geolocation.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
  - Architecture: architecture.md
  - Glossary: glossary.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
extra_css:
  - stylesheets/extra.css
  - stylesheets/wizard.css
extra_javascript:
  - javascripts/cloudsmith-versions.js
  - javascripts/connection-wizard.js
  - javascripts/page-toolbar.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