feat: add presenter mode documentation (#105)

slidevjs · Jan 20, 2023 · 9477d41 · 9477d41
1 parent 2236db4
commit 9477d41
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/custom/index.md b/custom/index.md
@@ -18,6 +18,8 @@ titleTemplate: '%s - Slidev'
 # information for your slides, can be a markdown string
 info: false
 
+# enable presenter mode, can be boolean, 'dev' or 'build'
+presenter: true
 # enabled pdf downloading in SPA build, can also be a custom url
 download: false
 # filename of the export file

diff --git a/guide/presenter-mode.md b/guide/presenter-mode.md
@@ -3,3 +3,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.
 
 ![](/screenshots/presenter-mode.png)
+
+## Disabling
+
+Presenter mode is enabled by default.
+
+You can disable this feature with the following config:
+
+```md
+---
+presenter: false
+---
+```
+
+Or you can enable it only for `dev` or `build` mode by setting the mode you want in the config:
+```md
+---
+presenter: dev
+---
+```
+In that case the presenter will only be available when running `slidev` but not when running `slidev build`.
+
+## Remote restricted access
+
+You can run your presentation with remote access by running `slidev --remote`.
+
+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.
+
+For this scenario you can provide a password for starting the server by running `slidev --remote=your_password`.
+
+In that case you will need to provide the password when accessing `/presenter/*` routes.