forked from Xpra-org/xpra
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
152 lines (144 loc) · 3.88 KB
/
mkdocs.yml
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
150
151
152
# Python dependencies required to generate documentation
# pip install mkdocs mkdocs-material mkdocs-material-extensions mkdocs-with-pdf
site_name: Xpra
site_url: https://xpra.org/wiki/
site_description: >-
Manage your remote systems with first-class virtual desktop support and connect
in seconds – sound, printing, notifications wherever you work
repo_name: xpra-org/xpra
repo_url: https://github.com/xpra-org/xpra
copyright: Xpra Authors
site_author: Xpra.org
docs_dir: docs
theme:
name: material
custom_dir: docs/.overrides
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
- navigation.instant
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: Roboto
code: Roboto Mono
favicon: http://xpra.org/icons/xpra-logo.png
logo: http://xpra.org/icons/xpra-logo.png
plugins:
- search
# - with-pdf:
# author: Xpra Authors
# copyright: 2023 Xpra Authors
# cover_title: Xpra Documentation
# output_path: docs.pdf
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- smarty
- tables
- toc:
permalink: true
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: xpra-org
repo: xpra
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
nav:
- Home: index.md
- Getting started:
- Installation:
- Installation.md
- Supported Operating Systems: Platforms.md
- Bug reporting:
- Report a Bug: Debugging.md
- Examples: Usage-Examples.md
- Versions: Versions.md
- Starting:
- Start Desktop: Usage/Start-Desktop.md
- Start Shadow: Usage/Shadow-Server.md
- Seamless: Usage/Seamless.md
- Setup:
- Audio: Features/Audio.md
- Video: Features/Image-Depth.md
- Clipboard: Features/Clipboard.md
- Display: Features/Display.md
- DPI: Features/DPI.md
- File Transfer: Features/File-Transfers.md
- Keyboard: Features/Keyboard.md
- Notifications: Features/Notifications.md
- Remote Printing: Features/Printing.md
- System Tray: Features/System-Tray.md
- Webcam: Features/Webcam.md
- Configure Network:
- Network/README.md
- AES: Network/AES.md
- Encryption: Network/Encryption.md
- Multicast DNS: Network/Multicast-DNS.md
- SSH: Network/SSH.md
- SSL: Network/SSL.md
- Advanced:
- Usage/README.md
- Authentication: Usage/Authentication.md
- Client OpenGL: Usage/Client-OpenGL.md
- Client: Usage/Client.md
- Configuration: Usage/Configuration.md
- Encodings:
- Introduction: Usage/Encodings.md
- Nvidia: Usage/NVENC.md
- Logging: Usage/Logging.md
- OpenGL: Usage/OpenGL.md
- Security: Usage/Security.md
- XDummy: Usage/Xdummy.md
- Use with Apache: Usage/Apache-Proxy.md
- Use in WSL: Usage/WSL.md
- Use Behind a Proxy: Usage/Proxy-Server.md
- Changelog: CHANGELOG.md