Commit Graph

564 Commits

Author SHA1 Message Date
Hakim El Hattab
c92d08acdd
Merge pull request #2378 from mbotsch/fix-plugin-documentation
Fix plugin documentation regarding init-Promises
2019-06-10 07:34:21 +02:00
autopp
f5759c3d52 add missing comma to MathJax example in README 2019-06-07 09:45:20 +09:00
Hakim El Hattab
25e521a16c Merge branch 'alternate-timing' of https://github.com/fghaas/reveal.js into dev 2019-05-27 08:08:00 +02:00
Florian Haas
23c12d7332 Notes: Weakly enforce a minimum allocated pacing time per slide
When using the totalTime-based pacing calculation, a presenter may
inadvertently set totalTime and per-slide data-timing attributes in
such a way that the pacing time for some slides is impossibly low or
even negative.

Add a check to ensure that the pacing on a slide never falls below a
configurable minimum, defaulting to 0. Display an alert if the
pacing for any slide(s) falls below the threshold.
2019-05-22 21:44:44 +02:00
Hakim El Hattab
bd1e82d19a new API methods for getting horizontal/vertical slides, force linear navigation for one-dimensional decks 2019-05-20 11:24:05 +02:00
Hakim El Hattab
1766e37a63 iframe background preload behavior now matches inline iframes + adheres to the new 'preloadIframes' config option 2019-05-13 10:55:29 +02:00
Florian Haas
078ba62050 Notes: Introduce alternate pacing timer, based on total presentation time
The current pacing timer operates on the assumption that there is
a default amount of time to be allocated to each slide, and that
individual slides can deviate from that default by specifying their
own data-timing attribute.

This patch introduces an alternate pacing method: by specifying
the totalTime configuration option, the presenter can set the total
time available to present. The pacing timer will then continue to
allocate the exact pacing time for slides that do have data-timing
set, as before. However, rather than applying the defaultTiming
constant to all others, it will

- Add up the time already allocated to slides via data-timing;
- subtract that from totalTime;
- divide the difference by the number of slides without data-timing set;
- apply the thus-calculated average to those slides.

totalTime has no default, and if both defaultTiming and totalTime are
set, totalTime wins. This preserves backward compatibility: if a
presenter has set defaultTiming and updates reveal.js, totalTime will
be null and defaultTiming is still applied to all slides without a
data-timing attribute. The presenter can then switch to the automatic
calculation, if desired, by setting a value for totalTime.
2019-05-12 20:10:06 +02:00
Daniel Noga
39ed39f3e2
update minimal nodejs version in readme 2019-05-05 13:34:43 +02:00
Mario Botsch
1f5fb971d4 Fix plugin documentation
Mention that reveal.js will wait for the Promise of a plugin's init()
function only when the plugin is loaded non-async. The init functions
of plugins that are loaded as async dependencies are called after
reveal.js has dispatched the 'ready' event.
2019-04-23 23:28:05 +02:00
Hakim El Hattab
a16b71a981 the postMessage API now works for getter methods 2019-04-23 10:52:45 +02:00
Hakim El Hattab
3643112b35
plugin doc tweaks 2019-04-03 10:49:14 +02:00
Hakim El Hattab
da4ec074f1
docs for code highlight line numbering 2019-04-01 15:45:07 +02:00
Hakim El Hattab
485870946f
plugin docs 2019-04-01 15:25:40 +02:00
Hakim El Hattab
25c504c22f
plugin api docs 2019-04-01 15:11:51 +02:00
Hakim El Hattab
d6f0f41f77 tweaks and tests for #2354 2019-03-28 15:42:28 +01:00
Max Rothman
93b1abc736 Add data-preload attribute for iframes
Allows lazy-loaded (i.e. data-src) iframes to be preloaded when they
come within the viewDistance, rather than once they're visible.
2019-03-22 10:45:08 -04:00
Hakim El Hattab
fbbae1dc55 switch to monokai as default syntax highlight theme 2019-03-12 11:26:10 +01:00
Hakim El Hattab
fc30774ef2
Merge pull request #2339 from mikeshatch/patch-1
Fixed a couple of typos
2019-03-06 13:31:16 +01:00
Mike Hatch
dd6f8b402c
Fixed a couple of typos 2019-03-04 12:24:04 -06:00
James
c2e048bc16
Update README.md with strike fragment
the strike type fragment was un-documented, so I stuck a mention of it in with the others.
2019-03-02 22:08:17 +08:00
Hakim El Hattab
7867b77833 indentation fix 2019-02-01 10:16:32 +01:00
Hakim El Hattab
ce53e63b5b documentation for #2315 2019-02-01 10:15:10 +01:00
Hakim El Hattab
812b802c1c resize event tweaks for #2300 2019-01-31 20:13:32 +01:00
Hakim El Hattab
9c1615fff1
Merge pull request #2300 from mw75/master
Resize Event
2019-01-31 20:09:45 +01:00
Hakim El Hattab
23c2d2795c
navigationMode documentation improvements 2019-01-23 10:43:05 +01:00
Hakim El Hattab
2fa3ab6a6b documentation for navigationMode #2307 2019-01-23 10:14:40 +01:00
Hakim El Hattab
baac3413ed upgrade to socket.io 2.2.0 #2257 2019-01-22 15:05:13 +01:00
Mario Wolff
126365627b fixed documentation on resize event 2019-01-15 13:18:55 +01:00
Mario Wolff
abee356e42 emmit resize event if scale changed 2019-01-15 13:13:19 +01:00
Hakim El Hattab
c36caef5e7 2019 2019-01-10 14:58:38 +01:00
Hakim El Hattab
b645828707 ensure history api is available, default to hash: true with no history in demo #2286 2018-12-19 11:04:29 +01:00
Hakim El Hattab
6ef565c9fb
Merge pull request #2286 from asottile/hash_without_history_2211
Add new 'hash: true' option which uses replaceState for url
2018-12-19 10:52:15 +01:00
Hakim El Hattab
dedad930e3
add section about vertical slides and gridNavigation to readme 2018-12-19 10:37:30 +01:00
Hakim El Hattab
c2270cc0c5 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2018-12-12 10:00:56 +01:00
Hakim El Hattab
0b3e7839eb
note about backticks to avoid LaTeX <> Markdown syntax conflicts #1359 2018-12-12 09:59:45 +01:00
Anthony Sottile
fd6245bb28 Add new 'hash: true' option which uses replaceState for url
Resolves #2211
2018-12-02 16:49:06 -08:00
Hakim El Hattab
8ac3383bee add getRevealElement API method 2018-11-16 10:39:43 +01:00
ggodreau
40bf81ce9b Fixes #2268
- Added clarification to README.md that 'markdown.js' and 'marked.js' scripts were imported within the default included index.html file
2018-11-01 08:18:21 -05:00
Hakim El Hattab
62cd74a890
add note about lazy loading iframes #1672 #1938 2018-10-09 11:08:09 +02:00
Hakim El Hattab
7b707696b4 automatically hide the mouse pointer after 5s of inactivity (#1837) 2018-10-08 09:58:06 +02:00
Hakim El Hattab
5890f602b3
Merge pull request #2090 from bnjmnt4n/math
Allow users to customise MathJax options.
2018-10-08 08:41:08 +02:00
Hakim El Hattab
196d2a3971 remove classlist polyfill, cross browser support is good enough now 2018-10-04 14:54:35 +02:00
Hakim El Hattab
01ceba3f73 remove mention of head.js in readme 2018-10-04 14:48:39 +02:00
Hakim El Hattab
90fc0bc466 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2018-10-03 12:53:07 +02:00
Hakim El Hattab
c35cce54a5
Merge pull request #2231 from esthor/patch-1
bring install instructions to top, as is tradition
2018-10-03 12:48:41 +02:00
Hakim El Hattab
f089e1b228 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2018-10-03 12:44:26 +02:00
Hakim El Hattab
436b41a8fc
dont refer to outdated speaker notes style in readme #2244 2018-10-03 12:43:00 +02:00
Erik
ed581add7f
bring install instructions to top, as is tradition
The Install was waaaay at the bottom, which didn't make sense to scroll through all the detailed documentation, just to find how to get started with an install.
2018-09-18 16:33:16 -04:00
Lele
b0ebb7deed
Fixed broken link to markdown options doc
Fixed broken link to markdown options doc
2018-08-16 14:34:46 +02:00
Hakim El Hattab
72b05a3245
Merge pull request #2171 from tristansokol/tristans/add-all-transitions
add a full list of transitions to readme
2018-08-01 10:36:07 +02:00
Hakim El Hattab
be87adcdf8 rename new fragment style 2018-06-13 14:12:28 +02:00
Hakim El Hattab
3680f1ad10 merge #1955 with minor changes 2018-06-11 12:35:11 +02:00
Hakim El Hattab
a9e95e7e6c merge conflicts 2018-06-11 11:02:21 +02:00
Hakim El Hattab
4bea8e17e8 add 'fade-in-then-half-out' fragment style, 'current-visible' was renamed to 'fade-in-then-out' 2018-06-11 10:59:31 +02:00
Tristan Sokol
27553e2fcb add a full list of transitions to readme 2018-06-05 09:30:02 -07:00
Hakim El Hattab
042fbde61b data-background-content-opacity -> data-background-opacity 2018-05-03 11:02:36 +02:00
Hakim El Hattab
4ba0d73345 add , adds wrapper element around background images/videos/iframes 2018-04-27 15:53:02 +02:00
marcvangend
ceb1738a0f
Clarify the meaning of the notes?: regex 2018-04-01 20:03:25 +02:00
craigsdennis
8ff5fe4986 Updates copyright to 2018 2018-03-16 22:41:16 -07:00
Hakim El Hattab
5848a432d9 Merge branch 'patch-1' of https://github.com/Jmuccigr/reveal.js into dev 2018-02-22 10:08:02 +01:00
Benjamin Tan
1427f7a1ae Cleanup readme to make it easier to read/edit.
- Use `single backticks` consistently for inline code snippets.
- Add double linefeeds before level 2 headings.
- Add a single linefeed after each heading.
- Minor docs edits.
2018-02-14 18:36:18 +08:00
Benjamin Tan
b2d532ea28 Allow users to customise MathJax options.
Ref. #1856, #2006, #2045.

This is a more open approach to allow customisation of all MathJax options instead of select options only.
2018-02-08 20:54:21 +08:00
Hakim El Hattab
5eba331935 Merge branch 'fragment-in-url' of https://github.com/dougalsutherland/reveal.js into dev 2018-02-07 10:33:19 +01:00
Benjamin Tan
7991693bde Docs: add note on how to enable/disable preview links individually.
Closes #2005.
2018-02-07 12:51:14 +08:00
Benjamin Tan
410f7767b9 Docs: mention that syntax highlighting requires CSS theme file.
Closes #2075.
2018-02-06 22:34:25 +08:00
Benjamin Tan
80bc1971e0 Docs: Add note about Windows carriage returns.
Closes #1808.
2018-02-06 19:39:03 +08:00
Hakim El Hattab
de746bb642 reorganize config options 2018-01-25 09:26:10 +01:00
Dougal J. Sutherland
260f287926 optionally put the fragment in the URL 2018-01-04 20:09:01 +00:00
Hakim El Hattab
6028844452 Merge branch 'plugin-key-bindings' of https://github.com/denehyg/reveal.js into dev 2017-11-29 09:38:05 +01:00
Hakim El Hattab
65bdccd580 lab.hakim.se/reveal-js -> revealjs.com 2017-11-22 14:46:55 +01:00
Hakim El Hattab
afce29d79a Merge branch 'master' of github.com:hakimel/reveal.js into dev 2017-11-09 11:51:59 +01:00
Hakim El Hattab
9d0a3d7d5e
Merge pull request #1983 from ssfrr/patch-1
adds note about necessary markdown scripts to README
2017-11-09 11:48:51 +01:00
Hakim El Hattab
41e86a2a22
Merge pull request #2017 from hoeggi/patch-1
Update README.md
2017-11-09 11:47:38 +01:00
hoeggi
8041759b8b
Update README.md 2017-10-28 19:57:35 +02:00
Spencer Russell
665d3a151d adds note about necessary markdown scripts to README 2017-09-11 15:13:37 -04:00
Chandan Rai
04dcc48fa9 corrected minor typo in readme file 2017-08-10 00:17:08 +05:30
Hakim El Hattab
67507ccb9d controlsHints -> controlsTutorial 2017-05-16 15:40:50 +02:00
Hakim El Hattab
9e013ccbb2 in/out transitions for controls 2017-05-16 15:31:05 +02:00
Greg Denehy
f8bc679182 Merge branch 'dev' into plugin-key-bindings 2017-04-30 17:42:16 +09:30
Greg Denehy
40a46e1c0c Added description of custom key binding API to readme 2017-04-30 17:19:01 +09:30
Hakim El Hattab
9f4ed56bb3 larger headings for background sections 2017-04-27 16:42:24 +02:00
Hakim El Hattab
caccf67d3a add for iframe backgrounds 2017-04-27 16:39:49 +02:00
Adam Spiers
715cf0ba11 optionally display pacing advice based on slide timings
Add an option to display advice on whether the current pace of the
presentation is on track for the right timing (shown as green), and if
not, whether the presenter should speed up (shown as red) or has the
luxury of slowing down (blue).

The pacing timer can be enabled by configuring by the `defaultTiming`
parameter in the `Reveal` configuration block, which specifies the
number of seconds per slide.  120 can be a reasonable rule of thumb.
Timings can also be given per slide `<section>` by setting the
`data-timing` attribute.  Both values are in numbers of seconds.

When the option is enabled, clicking on the timers will reset the timer
to the beginning of the current slide, i.e. as if pacing was perfectly
on track, not to zero as if the presentation had just begun.
2017-04-20 16:11:10 +01:00
Adam Spiers
921a605567 document clock and timer in speaker notes window 2017-04-20 15:18:15 +01:00
Adam Spiers
ef9cbbbbb9 add new getSlides() API
This can be used by plugins which are concerned with helping the
presenter with their pace.
2017-04-20 15:18:15 +01:00
Adam Spiers
40912ace1f clarify getTotalSlides() returns the number of slides 2017-04-20 15:18:15 +01:00
Adam Spiers
d75afd6108 expose getPastSlideCount() via public API
This can be used by plugins which are concerned with helping the
presenter with their pace.
2017-04-20 15:18:15 +01:00
Adam Spiers
eac37990e1 clarify meaning of getProgress() value 2017-04-20 15:18:15 +01:00
Christian Lawson-Perfect
9495b64d2c replace cdn.mathjax.org with cdnjs
cdn.mathjax.org is shutting down: https://www.mathjax.org/cdn-shutting-down/

This changes the default MathJax URL in the math plugin, as well as
references in README.md and test/examples/math.html
2017-04-05 12:48:56 +01:00
Hakim El Hattab
a0a3b4f80d add autoPlayMedia config option, overrides individual autoplay settings 2017-03-23 11:44:02 +01:00
Hakim El Hattab
b143e5976b tweaks to showSlideNumber config #1833 2017-02-20 11:49:36 +01:00
Hakim El Hattab
8f7e4bfd41 Merge branch 'slidenum' of https://github.com/malcomio/reveal.js into dev 2017-02-20 11:41:31 +01:00
Hakim El Hattab
5565d08612 note about deploying multiplex server with now #1830 2017-02-20 11:37:18 +01:00
Malcolm Young
95bca847d6 correct config name in README 2017-02-17 15:19:15 +00:00
Malcolm Young
da23d682c6 allow configuration of which view slide number appears on - fixes #1791 2017-02-17 15:08:57 +00:00
Hakim El Hattab
909efab7df fix readme conflict 2017-02-14 14:42:22 +01:00
Hakim El Hattab
bc1ca1a58a updated pdf docs 2017-02-14 14:40:12 +01:00
Hakim El Hattab
2f54af4614 update readme re: pdf exports #1823 2017-02-14 14:38:57 +01:00
Hakim El Hattab
5ad66f3779 docs for #1816 and remove showHelp 2017-02-09 11:37:47 +01:00
gilxa1226
d7b34b6e0f Update README.md to include block for pdf printing 2017-02-07 07:44:52 -05:00