webgate/mkdocs.yml at main · kalexnolasco/webgate · 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
site_name: webgate
site_description: Self-hosted web gateway for remote server management — SSH terminal, SFTP, jump hosts, shared sessions, session recording, LDAP, webhooks, HA.
site_url: https://kalexnolasco.github.io/webgate/
repo_url: https://github.com/kalexnolasco/webgate
repo_name: kalexnolasco/webgate

theme:
  name: material
  palette:
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Light mode
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Dark mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.expand
    - search.highlight
    - toc.follow
  icon:
    repo: fontawesome/brands/github

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Local playground: LOCAL_TESTING.md
  - User Guide:
    - Server Management: guide/servers.md
    - SSH Terminal: guide/terminal.md
    - SFTP File Browser: guide/files.md
    - Split View: guide/split.md
    - User Management: guide/users.md
    - Access model (groups, LDAP, tags): guide/access-control.md
    - Advanced (jump host, snippets, sharing, recording): guide/advanced.md
    - Integrations (webhooks, LDAP, API keys, reverse proxy): guide/integrations.md
    - HA deployment: guide/ha.md
  - API Reference:
    - Authentication: api/auth.md
    - Servers: api/servers.md
    - Terminal: api/terminal.md
    - Files: api/files.md
  - Changelog: changelog.md

plugins:
  - search

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
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true