document dependency loading
This commit is contained in:
parent
49e8e0d205
commit
95898dc9e3
1 changed files with 20 additions and 0 deletions
20
README.md
20
README.md
|
@ -80,6 +80,26 @@ Reveal.initialize({
|
|||
});
|
||||
```
|
||||
|
||||
### Dependencies
|
||||
|
||||
Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example:
|
||||
|
||||
```javascript
|
||||
Reveal.initialize({
|
||||
dependencies: [
|
||||
{ src: 'lib/js/highlight.js', async: true, callback: function() { window.hljs.initHighlightingOnLoad(); } },
|
||||
{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }
|
||||
]
|
||||
});
|
||||
```
|
||||
|
||||
You can add your own extensions using the same syntax. The following properties are available for each dependency object:
|
||||
- **src**: Path to the script to load
|
||||
- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
|
||||
- **callback**: [optional] Function to execute when the script has loaded
|
||||
- **condition**: [optional] Function which must return true for the script to be loaded
|
||||
|
||||
|
||||
### API
|
||||
|
||||
The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
|
||||
|
|
Loading…
Reference in a new issue