Skip to content

Commit ac400ec

Browse files
committed
Documentation overhaul
1 parent 233ce1b commit ac400ec

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# PdfExport
22

3-
A [reveal.js](https://github.com/hakimel/reveal.js/) plugin to easly switch between screen and the built-in PDF export mode by pressing a shortcut key.
3+
A [reveal.js](https://github.com/hakimel/reveal.js/) plugin to easly switch to the built-in PDF export mode and back by pressing a shortcut key.
44

55
## Installation
66

@@ -18,7 +18,7 @@ Reveal.initialize({
1818
});
1919
```
2020

21-
You need to remove all of the following or similar lines from your presentation. Paper or PDF stylesheets will be set by the plugin.
21+
You need to remove all of the following or similar lines from your presentation. Paper- or PDF-stylesheets will be set by the plugin.
2222

2323
```html
2424
<!-- Printing and PDF exports -->
@@ -35,7 +35,9 @@ You need to remove all of the following or similar lines from your presentation.
3535

3636
To toggle between screen and PDF mode you can press the ```E``` shortcut on the keyboard.
3737

38-
### Parameter
38+
### Configuration
39+
40+
You can configure some aspects of the plugin by adding the following options to your reveal configuration. Note that all configuration values are optional and will default to the values specified below.
3941

4042
```javascript
4143
Reveal.initialize({
@@ -50,4 +52,4 @@ Reveal.initialize({
5052

5153
[MIT licensed](https://en.wikipedia.org/wiki/MIT_License).
5254

53-
Copyright (C) 2018 [Sören Weber](https://soeren-weber.de)
55+
Copyright (C) 2020 [Sören Weber](https://soeren-weber.de)

0 commit comments

Comments
 (0)