-
Notifications
You must be signed in to change notification settings - Fork 40
/
mkdocs.yml
196 lines (187 loc) · 10.1 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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# MkDocs configuration file.
# https://www.mkdocs.org/user-guide/configuration/
# Project information.
site_name: OpenVidu Docs
site_url: https://docs.openvidu.io/
repo_url: https://github.com/OpenVidu/openvidu.io-docs
edit_uri: blob/master/docs/
site_description: OpenVidu documentation pages
# Documentation layout.
nav:
- OpenVidu v3: openvidu3.md
- What is OpenVidu?: index.md
- Getting started: getting-started/index.md
- Developing your video app: developing-your-video-app/index.md
- Application server:
- Intro: application-server/index.md
- Samples:
- openvidu-basic-java: application-server/openvidu-basic-java.md
- openvidu-basic-node: application-server/openvidu-basic-node.md
- openvidu-basic-python: application-server/openvidu-basic-python.md
- openvidu-basic-dotnet: application-server/openvidu-basic-dotnet.md
- openvidu-basic-ruby: application-server/openvidu-basic-ruby.md
- User Authentication: application-server/user-authentication.md
- Ready-to-use component: ready-to-use-component/index.md
- OpenVidu Components:
- Intro: components/index.md
- Tutorials:
- openvidu-custom-ui: components/openvidu-custom-ui.md
- openvidu-custom-toolbar: components/openvidu-custom-toolbar.md
- openvidu-toolbar-buttons: components/openvidu-toolbar-buttons.md
- openvidu-toolbar-panel-buttons: components/openvidu-toolbar-panel-buttons.md
- openvidu-custom-layout: components/openvidu-custom-layout.md
- openvidu-custom-stream: components/openvidu-custom-stream.md
- openvidu-custom-panels: components/openvidu-custom-panels.md
- openvidu-additional-panels: components/openvidu-additional-panels.md
- openvidu-custom-chat-panel: components/openvidu-custom-chat-panel.md
- openvidu-custom-activities-panel: components/openvidu-custom-activities-panel.md
- openvidu-custom-participants-panel: components/openvidu-custom-participants-panel.md
- openvidu-custom-participant-panel-item: components/openvidu-custom-participant-panel-item.md
- openvidu-custom-participant-panel-item-elements: components/openvidu-custom-participant-panel-item-elements.md
- openvidu-toggle-hand: components/openvidu-toggle-hand.md
- openvidu-admin-dashboard: components/openvidu-admin-dashboard.md
# - openvidu-call-ionic: components/openvidu-call-ionic.md
- OpenVidu Call: components/openvidu-call.md
- Full control of the UI:
- Intro: full-control-ui/index.md
- Hello World: tutorials/openvidu-hello-world.md
- Basic Tutorials:
- openvidu-js: tutorials/openvidu-js.md
- openvidu-angular: tutorials/openvidu-angular.md
- openvidu-react: tutorials/openvidu-react.md
- openvidu-vue: tutorials/openvidu-vue.md
- openvidu-ionic: tutorials/openvidu-ionic.md
- openvidu-react-native: tutorials/openvidu-react-native.md
- openvidu-electron: tutorials/openvidu-electron.md
- openvidu-android: tutorials/openvidu-android.md
- openvidu-ios: tutorials/openvidu-ios.md
- Other Tutorials:
- openvidu-iframe: tutorials/openvidu-iframe.md
- openvidu-js-screen-share: tutorials/openvidu-js-screen-share.md
- openvidu-library-react: tutorials/openvidu-library-react.md
- openvidu-ionic-cordova: tutorials/openvidu-ionic-cordova.md
- openvidu-ipcameras: tutorials/openvidu-ipcameras.md
- openvidu-filters: tutorials/openvidu-filters.md
- openvidu-virtual-background: tutorials/openvidu-virtual-background.md
- openvidu-speech-to-text: tutorials/openvidu-speech-to-text.md
- openvidu-roles-java: tutorials/openvidu-roles-java.md
- openvidu-roles-node: tutorials/openvidu-roles-node.md
- openvidu-recording-java: tutorials/openvidu-recording-java.md
- openvidu-recording-node: tutorials/openvidu-recording-node.md
- Demos:
- openvidu-getaroom: demos/openvidu-getaroom.md
- openvidu-classroom: demos/openvidu-classroom.md
- openvidu-call-react: demos/openvidu-call-react.md
- Cheatsheet:
- Join a session: cheatsheet/join-session.md
- Leave a session: cheatsheet/leave-session.md
- Subscribe/Unsubscribe from a stream: cheatsheet/subscribe-unsubscribe.md
- Publish/Unpublish a stream: cheatsheet/publish-unpublish.md
- Mute/Unmute audio and video: cheatsheet/mute-audio-video.md
- Manage video players: cheatsheet/manage-videos.md
- Share data between users: cheatsheet/share-data.md
- Send text messages: cheatsheet/send-messages.md
- Advanced features:
- Recording: advanced-features/recording.md
- Media Codecs: advanced-features/media-codecs.md
- Screen share: advanced-features/screen-share.md
- IP cameras: advanced-features/ip-cameras.md
- Speech detection: advanced-features/speech-detection.md
- Voice and video filters: advanced-features/filters.md
- Switch camera: advanced-features/switch-camera.md
- Automatic reconnection: advanced-features/automatic-reconnection.md
- Phone calls integration: advanced-features/sip.md
- Network quality: advanced-features/network-quality.md
- Virtual Background: advanced-features/virtual-background.md
- Speech To Text: advanced-features/speech-to-text.md
- Broadcast to YouTube/Twitch: advanced-features/broadcast.md
- Reference Documentation:
- openvidu-browser API: reference-docs/openvidu-browser.md
- openvidu-java-client API: reference-docs/openvidu-java-client.md
- openvidu-node-client API: reference-docs/openvidu-node-client.md
- openvidu-angular API: reference-docs/openvidu-angular.md
- REST API: reference-docs/REST-API.md
- OpenVidu configuration: reference-docs/openvidu-config.md
- OpenVidu Webhook: reference-docs/openvidu-server-webhook.md
- OpenVidu CDR: reference-docs/openvidu-server-cdr.md
- Deployment:
- Intro: deployment/index.md
- OpenVidu CE:
- AWS: deployment/ce/aws.md
- On premises: deployment/ce/on-premises.md
- Upgrading: deployment/ce/upgrading.md
- OpenVidu Pro:
- AWS: deployment/pro/aws.md
- On premises: deployment/pro/on-premises.md
- Upgrading: deployment/pro/upgrading.md
- OpenVidu Enterprise:
- AWS: deployment/enterprise/aws.md
- On premises: deployment/enterprise/on-premises.md
- Upgrading: deployment/enterprise/upgrading.md
- Deploy OpenVidu applications: deployment/deploying-openvidu-apps.md
- Allow users behind firewalls: deployment/allow-users-behind-firewalls.md
- Contribute:
- Developing OpenVidu: developing/index.md
- OpenVidu Server RPC protocol: developing/rpc.md
- Troubleshooting / FAQ: troubleshooting/index.md
- Releases: releases/index.md
- OpenVidu Pro:
- Home: openvidu-pro/index.md
- Scalability: openvidu-pro/scalability.md
- Fault tolerance: openvidu-pro/fault-tolerance.md
- OpenVidu Inspector: openvidu-pro/openvidu-inspector.md
- Monitoring - Elastic Stack: openvidu-pro/monitoring-elastic-stack.md
- OpenVidu Enterprise:
- Home: openvidu-enterprise/index.md
- Simulcast: openvidu-enterprise/simulcast.md
- High availability: openvidu-enterprise/high-availability.md
# Build directories.
theme:
name: mkdocs
locale: en
custom_dir: custom_theme/
docs_dir: docs/
site_dir: site/
# Preview controls.
strict: false
dev_addr: "127.0.0.1:8000"
# Formatting options.
markdown_extensions:
# Extra features for Markdown: https://python-markdown.github.io/extensions/extra/
# - Abbreviations: https://python-markdown.github.io/extensions/abbreviations/
# - Attribute Lists: https://python-markdown.github.io/extensions/attr_list/
# - Definition Lists: https://python-markdown.github.io/extensions/definition_lists/
# - Fenced Code Blocks: https://python-markdown.github.io/extensions/fenced_code_blocks/
# - Footnotes: https://python-markdown.github.io/extensions/footnotes/
# - Tables: https://python-markdown.github.io/extensions/tables/
# - Markdown in HTML: https://python-markdown.github.io/extensions/md_in_html/
- extra
# Table of Contents: https://python-markdown.github.io/extensions/toc/
- toc:
marker: "[TOC]"
permalink: " 🔗"
plugins:
- search:
separator: '[\s]+'
- exclude-search:
exclude:
# This is a special unstyled file that contains all Release Notes.
- common/releases-content.md
# Environment Variables.
# Make RTD env vars available to the template context.
# Syntax:
# * https://www.mkdocs.org/user-guide/configuration/#environment-variables
# * https://www.mkdocs.org/dev-guide/themes/#extra-context
# RTD env vars:
# * https://docs.readthedocs.io/en/stable/builds.html#build-environment
#
# FIXME: This should be used to set the <base> URL in the HTML template,
# but for some readon RTD sets these to the string "null", so an alternative
# had to be used while the issue gets fixed. Issue report:
# READTHEDOCS environment variables are null #8529
# https://github.com/readthedocs/readthedocs.org/issues/8529
extra:
READTHEDOCS: !ENV [READTHEDOCS, null]
READTHEDOCS_VERSION: !ENV [READTHEDOCS_VERSION, null]
READTHEDOCS_PROJECT: !ENV [READTHEDOCS_PROJECT, null]
READTHEDOCS_LANGUAGE: !ENV [READTHEDOCS_LANGUAGE, null]