Commit Graph

504 Commits

Author SHA1 Message Date
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
gilxa1226 bcfb65658f Update README.md 2017-02-07 07:43:41 -05:00
Hakim El Hattab 9f99ac8b84 adjust comment for display config value #1325 2017-02-02 10:47:39 +01:00
Hakim El Hattab eada86c8fd recommend using textarea wrapper for inline markdown #1780 2017-01-31 15:07:03 +01:00
Hakim El Hattab 3617eaccb6 note about showNotes in PDF exports #1800 2017-01-30 14:50:17 +01:00
Hakim El Hattab fa01fa366a typo 2017-01-30 14:38:14 +01:00
Hakim El Hattab c018d04197 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2017-01-30 14:33:52 +01:00
Jason Dreyzehner e3ca5e84a3 correct grunt option usage 2017-01-23 21:26:33 -05:00
Hakim El Hattab e8164c1392 2017 2017-01-20 10:35:01 +01:00
Hakim El Hattab 941b86b6c3 works with video, defaults to (same as for images) 2017-01-18 10:43:29 +01:00
Hakim El Hattab 568c7516f7 fix unclosed code block 2017-01-10 14:43:47 +01:00
Hakim El Hattab 40c4db1e04 always use lowercase reveal.js 2016-12-13 15:52:34 +01:00
Benjamin Tan 4d0f1adc40 Add note about head.js to readme.
Closes #1569.
2016-12-11 16:29:07 +08:00
Benjamin Tan 90b301d0a0 Enable passing options for parsing Markdown.
Closes #1163, #1495.
2016-12-08 17:41:55 +08:00
Benjamin Tan 03ac4a2e8e Reduce required Node.js version to 4.0.0.
The development workflow can be used with Node 4+, not just Node 6. We
should avoid showing warnings and errors when users are installing this
package via npm/yarn.

Ref. #1729, #1743.
Closes #1725.
2016-12-06 18:12:41 +08:00
Hakim El Hattab e460b2bd4b Merge pull request #1747 from spencermathews/feature/readme-defaults-fix
Defaults in README are not current
2016-12-01 10:23:44 +01:00
Hakim El Hattab 775d510c2f Merge pull request #1756 from jmpp/better-data-trim
Implementing a better data-trim
2016-12-01 10:18:50 +01:00
Spencer Mathews 21c1fafa52 Update README.md to reflect current defaults in js/reveal.js 2016-11-15 13:14:56 -08:00
Jaiden Mispy 3c36ee6cff Add note to README about how to disable scaling 2016-10-05 11:16:41 +02:00
Hakim El Hattab 6447b59ac5 ready flag on .reveal container 2016-07-01 08:44:27 +02:00
David Beitey 1fe20cb42a Detail markdown plugin attributes & defaults
Expands the details already given by highlighting the defaults for all attributes and clarifying what's required.
2016-06-22 15:10:31 +10:00
Hakim El Hattab d78a8046dc Merge branch 'Timothep-master' into dev 2016-06-10 10:13:06 +02:00
Timothep 02123205a0 Added a description of the undocumented timer-reset feature 2016-06-10 10:12:54 +02:00
Hakim El Hattab ca92d22adc add showHelp to api #1611 2016-06-10 10:04:54 +02:00
Hakim El Hattab 7d6cc9f3ec Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-06-03 13:57:09 +02:00
Hakim El Hattab c2997c605d text alignment 2016-06-03 13:56:52 +02:00
Hakim El Hattab 6b4bdd2c90 hdpi slides banner 2016-06-03 13:54:42 +02:00
Hakim El Hattab f9ae4122f7 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-06-03 10:15:34 +02:00
Hakim El Hattab 904f9878d3 slides banner 2016-06-03 10:15:26 +02:00
Hakim El Hattab 3111d3b1ae support for 'separate-page' layout for notes in PDF exports #1518 2016-05-26 09:57:27 +02:00
Hakim El Hattab e93afb7289 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-05-23 12:03:39 +02:00
Hakim El Hattab a8c4109244 Update README.md
more in-depth documentation of slide backgrounds #1542
2016-05-23 11:59:29 +02:00
Hakim El Hattab 2503b1a2e8 merge readme conflict #1595 2016-05-23 10:34:58 +02:00
Tristan Sokol b79f1fac13 Add minor imporovements to the PDF export instructions 2016-05-19 16:47:25 -07:00
Hakim El Hattab 2a79d054d4 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-04-29 09:26:41 +02:00
Hakim El Hattab 5558103522 make max pages per slide limit configurable 2016-04-28 11:31:11 +02:00
Adrian Sieber 87b082340f Simplify full setup 2016-04-24 09:39:23 +00:00
Hakim El Hattab fc3e4d7f23 change introduction 2016-04-18 14:50:36 +02:00
Hakim El Hattab 1efa52486c readme tweak for #1535 2016-04-13 15:37:04 +02:00
Hakim El Hattab e83e275a4c Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-04-07 10:31:56 +02:00
Hakim El Hattab d6406e433e new multiplex server courtesy of now.sh (closes #1377) 2016-04-07 10:31:41 +02:00
Hakim El Hattab 492e2e2e62 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-04-07 10:25:31 +02:00
Hakim El Hattab eca7113f59 Update README.md 2016-04-07 09:55:44 +02:00
Hakim El Hattab f98b5ccdca Update README.md
readme tweaks
2016-04-07 09:55:04 +02:00
Tomasz Ducin 37ac67dba5 Table of contents added in README.md 2016-04-02 19:43:15 +02:00
Hakim El Hattab 2625a9292e add 'shuffle' config value and API method #1506 #1089 2016-03-20 17:57:52 +01:00
Hakim El Hattab 0dbdd8a366 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-03-10 16:03:09 +01:00
Hakim El Hattab de2ab07334 slides link 2016-03-10 16:02:36 +01:00
Benjamin Tan ac2a3fff75 Make PDF export section less OS X specific.
Closes #1073.
2016-03-07 19:15:59 +08:00
Hakim El Hattab 0eb2d81f35 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-03-04 14:47:01 +01:00
Hakim El Hattab c6b6ae4397 Merge pull request #1484 from omer727/patch-1
Fixing spelling typo and GitHub proper camelcase for brand name
2016-03-04 14:46:33 +01:00
Hakim El Hattab 191dbe68d5 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-01-22 11:09:39 +01:00
Hakim El Hattab c93fbf1ddc readme tweak 2016-01-22 11:02:05 +01:00
Hakim El Hattab fc1c239743 add barebones example to readme 2016-01-22 10:59:02 +01:00
omer727 6af739f81c Fixing spelling typo and GitHub proper camelcase for brand name 2016-01-17 14:42:56 +02:00
Hakim El Hattab d0bb69d427 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-01-11 10:34:01 +01:00
Hakim El Hattab 8a40bb481e note about showNotes in PDF exports 2016-01-11 10:33:40 +01:00
Hakim El Hattab fba12abd6a Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-01-11 10:05:25 +01:00
Prateek Saxena 7eca84254e Remove rebase conflict in README.md 2016-01-11 05:19:28 +05:30
Hakim El Hattab ddd0e85f41 Merge branch 'master' of github.com:hakimel/reveal.js into dev 2016-01-08 10:49:40 +01:00
Hakim El Hattab c3919756f1 resolve conflict 2016-01-08 10:48:10 +01:00