Skip to content

Commit 37797ff

Browse files
authored
feat: update config doc (#65)
1 parent 0daa359 commit 37797ff

File tree

1 file changed

+27
-9
lines changed

1 file changed

+27
-9
lines changed

custom/index.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,45 @@ You can configure Slidev in the frontmatter of your first slide, the following s
1111
# theme id or package name
1212
theme: 'default'
1313
# title of your slide, will auto infer from the first header if not specified
14-
title: ''
14+
title: 'Slidev'
1515
# titleTemplate for the webpage, `%s` will be replaced by the page's title
1616
titleTemplate: '%s - Slidev'
17+
# information for your slides, can be a markdown string
18+
info: false
1719

1820
# enabled pdf downloading in SPA build, can also be a custom url
19-
download: true
21+
download: false
22+
# filename of the export file
23+
exportFilename: 'slidev-exported.pdf'
2024
# syntax highlighter, can be 'prism' or 'shiki'
2125
highlighter: 'prism'
2226
# show line numbers in code blocks
2327
lineNumbers: false
24-
# enable monaco editor, default to dev only
28+
# enable monaco editor, can be boolean, 'dev' or 'build'
2529
monaco: 'dev'
30+
# download remote assets in local using vite-plugin-remote-assets, can be boolean, 'dev' or 'build'
31+
remoteAssets: false
32+
# controls whether texts in slides are selectable
33+
selectable: true
34+
# enable slide recording, can be boolean, 'dev' or 'build'
35+
record: 'dev'
2636

27-
# force color schema for the slides, could be 'auto', 'light', or 'dark'
37+
# force color schema for the slides, can be 'auto', 'light', or 'dark'
2838
colorSchema: 'auto'
29-
# router mode for vue-router, could be "history" or "hash"
39+
# router mode for vue-router, can be "history" or "hash"
3040
routerMode: 'history'
3141
# aspect ratio for the slides
3242
aspectRatio: '16/9'
3343
# real width of the canvas, unit in px
3444
canvasWidth: 980
45+
# used for theme customization, will inject root styles as `--slidev-theme-x` for attribute `x`
46+
themeConfig:
47+
primary: '#5d8392'
3548

3649
# favicon, can be a local file path or URL
3750
favicon: 'https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png'
51+
# URL of PlantUML server used to render diagrams
52+
plantUmlServer: 'https://www.plantuml.com/plantuml'
3853
# fonts will be auto imported from Google fonts
3954
# Learn more: https://sli.dev/custom/fonts
4055
fonts:
@@ -47,10 +62,13 @@ defaults:
4762
layout: 'default'
4863
# ...
4964

50-
# information for your slides, can be a markdown string
51-
info: |
52-
## Slidev
53-
My first [Slidev](http://sli.dev/) presentations!
65+
# drawing options
66+
# Learn more: https://sli.dev/guide/drawing.html
67+
drawings:
68+
enabled: true
69+
persist: false
70+
presenterOnly: false
71+
syncAll: true
5472
---
5573
```
5674

0 commit comments

Comments
 (0)