TermBeam/mkdocs.yml at main · dorlugasigal/TermBeam · 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
site_name: TermBeam
site_url: https://dorlugasigal.github.io/TermBeam
site_description: >-
  TermBeam — access your terminal from any device. Mobile-optimized web terminal
  with multi-session support, touch controls, and one-command setup via npx.
  No SSH needed.
site_author: dorlugasigal
repo_url: https://github.com/dorlugasigal/TermBeam
repo_name: dorlugasigal/TermBeam

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dorlugasigal/TermBeam
    - icon: fontawesome/brands/npm
      link: https://www.npmjs.com/package/termbeam
  # analytics:
  #   provider: google
  #   property: G-XXXXXXXXXX  # TODO: Replace with your GA4 measurement ID

plugins:
  - search
  # - social  # Auto-generates og:image for each page (requires pillow and cairosvg: pip install pillow cairosvg)

theme:
  name: material
  palette:
    - scheme: slate
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: teal
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
  icon:
    repo: fontawesome/brands/github
    logo: material/console
  font:
    text: Inter
    code: JetBrains Mono

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Comparison: comparison.md
  - Use Cases: use-cases.md
  - Usage Guide: usage-guide.md
  - Configuration: configuration.md
  - Resume & List: resume.md
  - Running in Background: running-in-background.md
  - Security: security.md
  - API Reference: api.md
  - Architecture: architecture.md
  - Troubleshooting: troubleshooting.md
  - Contributing: contributing.md