Skip to content

Commit 9477d41

Browse files
authored
feat: add presenter mode documentation (#105)
1 parent 2236db4 commit 9477d41

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

custom/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ titleTemplate: '%s - Slidev'
1818
# information for your slides, can be a markdown string
1919
info: false
2020

21+
# enable presenter mode, can be boolean, 'dev' or 'build'
22+
presenter: true
2123
# enabled pdf downloading in SPA build, can also be a custom url
2224
download: false
2325
# filename of the export file

guide/presenter-mode.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,33 @@
33
Click the <carbon-user-speaker class="inline-icon-btn"/> button in the navigation panel, or visit `http://localhost:3030/presenter` manually, to enter the presenter mode. Whenever you enter the presenter mode, other page instances will automatically stay in sync with the presenter.
44

55
![](/screenshots/presenter-mode.png)
6+
7+
## Disabling
8+
9+
Presenter mode is enabled by default.
10+
11+
You can disable this feature with the following config:
12+
13+
```md
14+
---
15+
presenter: false
16+
---
17+
```
18+
19+
Or you can enable it only for `dev` or `build` mode by setting the mode you want in the config:
20+
```md
21+
---
22+
presenter: dev
23+
---
24+
```
25+
In that case the presenter will only be available when running `slidev` but not when running `slidev build`.
26+
27+
## Remote restricted access
28+
29+
You can run your presentation with remote access by running `slidev --remote`.
30+
31+
In that case you may want to share the slides with other people but you don't want them to access the presenter mode to mess up your presentation.
32+
33+
For this scenario you can provide a password for starting the server by running `slidev --remote=your_password`.
34+
35+
In that case you will need to provide the password when accessing `/presenter/*` routes.

0 commit comments

Comments
 (0)