orb/mkdocs.yml at main · Zayan-Mohamed/orb · 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
site_name: Orb Documentation
site_description: Zero-Trust Folder Tunneling Tool - Secure file sharing with end-to-end encryption
site_author: Orb Team
site_url: https://orb.example.com

repo_name: Zayan-Mohamed/orb
repo_url: https://github.com/Zayan-Mohamed/orb
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Quick Start: quickstart.md
      - Installation: getting-started/installation.md
      - First Steps: getting-started/first-steps.md
      - Examples: getting-started/examples.md
  - User Guide:
      - Commands: user-guide/commands.md
      - Sharing Files: user-guide/sharing.md
      - Connecting: user-guide/connecting.md
      - TUI Browser: user-guide/tui.md
      - Troubleshooting: user-guide/troubleshooting.md
  - Security:
      - Overview: security.md
      - Cryptography: security/cryptography.md
      - Best Practices: security/best-practices.md
      - Threat Model: security/threat-model.md
  - Deployment:
      - Overview: deployment.md
      - Relay Server: deployment/relay-server.md
      - Production Setup: deployment/production.md
      - Docker: deployment/docker.md
  - Development:
      - Architecture: architecture.md
      - Building: development/building.md
      - Contributing: development/contributing.md
      - API Reference: development/api.md
  - About:
      - License: about/license.md
      - Changelog: about/changelog.md
      - FAQ: about/faq.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Zayan-Mohamed/orb
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/orb
  version:
    provider: mike

copyright: Copyright &copy; 2026 Orb Project