big rewrite of readme
This commit is contained in:
Hakim El Hattab
parent
0337193790
commit
669c86e16b
151
README.md
151
README.md
|
|
@ -1,12 +1,17 @@
|
||||||
# reveal.js
|
# reveal.js
|
||||||
|
|
||||||
A CSS 3D slideshow tool for quickly creating good looking HTML presentations. Doesn't _rely_ on any external libraries but [highlight.js](http://softwaremaniacs.org/soft/highlight/en/description/) is included by default for code highlighting.
|
A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
|
||||||
|
|
||||||
Note that this requires a browser with support for CSS 3D transforms and ``classList``. If CSS 3D support is not detected, the presentation will degrade to less exciting 2D transitions. A [classList polyfill](http://purl.eligrey.com/github/classList.js/blob/master/classList.js) is incuded to make this work in < iOS 5, < Safari 5.1 and IE.
|
reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
|
||||||
|
|
||||||
Curious about how it looks in action? [Check out the demo page](http://lab.hakim.se/reveal-js/).
|
|
||||||
|
|
||||||
## Usage
|
#### More reading in the Wiki:
|
||||||
|
- [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history
|
||||||
|
- [Examples](https://github.com/hakimel/reveal.js/wiki/Examples): Presentations created with reveal.js
|
||||||
|
- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Changelog): Explanation of browser support and fallbacks
|
||||||
|
|
||||||
|
|
||||||
|
## Instructions
|
||||||
|
|
||||||
### Markup
|
### Markup
|
||||||
|
|
||||||
|
|
@ -41,7 +46,7 @@ This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Iri
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
At the end of your page, after ``<script src="js/reveal.js"></script>``, you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
|
At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
Reveal.initialize({
|
Reveal.initialize({
|
||||||
|
|
@ -135,13 +140,6 @@ Reveal.addEventListener( 'fragmenthidden', function( event ) {
|
||||||
} );
|
} );
|
||||||
```
|
```
|
||||||
|
|
||||||
### Folder Structure
|
|
||||||
- **css/** Core styles without which the project does not function
|
|
||||||
- **js/** Like above but for JavaScript
|
|
||||||
- **plugin/** Components that have been developed as extensions to reveal.js
|
|
||||||
- **lib/** All other third party assets (JavaScript, CSS, fonts)
|
|
||||||
|
|
||||||
|
|
||||||
## PDF Export
|
## PDF Export
|
||||||
|
|
||||||
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
|
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
|
||||||
|
|
@ -176,131 +174,14 @@ You can change the appearance of the speaker notes by editing the file at `plugi
|
||||||
|
|
||||||
- The notes page is supposed to show the current slide and the next slide, but when it first starts, it always shows the first slide in both positions.
|
- The notes page is supposed to show the current slide and the next slide, but when it first starts, it always shows the first slide in both positions.
|
||||||
|
|
||||||
## Examples
|
## Folder Structure
|
||||||
|
- **css/** Core styles without which the project does not function
|
||||||
* http://lab.hakim.se/reveal-js/ (original)
|
- **js/** Like above but for JavaScript
|
||||||
* http://www.ideapolisagency.com/ by [@achrafkassioui](http://twitter.com/achrafkassioui)
|
- **plugin/** Components that have been developed as extensions to reveal.js
|
||||||
* http://lucienfrelin.com/ by [@lucienfrelin](http://twitter.com/lucienfrelin)
|
- **lib/** All other third party assets (JavaScript, CSS, fonts)
|
||||||
* http://creatorrr.github.com/ThePoet/
|
|
||||||
* http://moduscreate.com/ by [@ModusCreate](https://twitter.com/ModusCreate)
|
|
||||||
* http://idea.diwank.name/ by [Diwank Singh](http://diwank.name/)
|
|
||||||
* [Webapp Development Stack & Tooling](http://dl.dropbox.com/u/39519/talks/jquk-tooling%2Bappstack/index.html) by [Paul Irish](https://github.com/paulirish)
|
|
||||||
* [Lock-free algorithms](http://concurrencykit.org/presentations/lockfree_introduction/) by Samy Al Bahra
|
|
||||||
* [Not Your Average Drag and Drop](http://www.thecssninja.com/talks/not_your_average_dnd/) by [Ryan Seddon](https://github.com/ryanseddon)
|
|
||||||
* [Elasticsearch](http://spinscale.github.com/elasticsearch/2012-03-jugm.html) by [@spinscale](http://twitter.com/spinscale)
|
|
||||||
* [JavaScript Tooling](http://dl.dropbox.com/u/39519/talks/jsconf-tools/index.html) by [Paul Irish](https://github.com/paulirish)
|
|
||||||
* [The Graphical Web: Fostering Creativity](http://vhardy.github.com/presentations/html5-community-meet-up-2012/) by [Vincent Hardy](https://github.com/vhardy)
|
|
||||||
* [Mobile Web Programming is a Bloody Mess](http://westcoastlogic.com/slides/debug-mobile/) by [Brian LeRoux](https://github.com/brianleroux)
|
|
||||||
* [Bio Database Access and Sequence Alignment](http://www.philipbjorge.com/bioinformatics-presentation/) by [Philip Bjorge](https://github.com/philipbjorge)
|
|
||||||
* [Web vs Native](http://prez.mahemoff.com/state-native/) by [Michael Mahemoff](https://github.com/mahemoff)
|
|
||||||
* [Continuously Integrated JS Development](http://trodrigues.net/presentations/buster-ci/) by [Tiago Rodrigues](https://github.com/trodrigues)
|
|
||||||
* [To be Future Friendly is to be Device Agnostic](http://dl.dropbox.com/u/409429/presentations/toster-2012/index.html) by [Joe McCann](https://github.com/joemccann)
|
|
||||||
* [The Web Development Workflow of 2013](http://dl.dropbox.com/u/39519/talks/fluent/index.html) by [Paul Irish](https://github.com/paulirish)
|
|
||||||
* [How To Cope With Graphical Challenges Using Latest Web Technologies](http://alexw.me/playground/slideshows/w3c_netcraft/) by [Alex Wolkov](https://github.com/altryne)
|
|
||||||
* [Going Deeper with jQuery Mobile](http://andymatthews.net/downloads/presentations/going-deeper-with-jquery-mobile/) by [Andy Matthews](https://github.com/commadelimited)
|
|
||||||
* [Studio Nord](http://studionord.org)
|
|
||||||
* [Herrljunga Cider](http://herrljungacider.se/uk/campaign/)
|
|
||||||
* [PhoneGap Pain Points](http://phonegap-pain-points.appspot.com/) by [Pamela Fox](https://github.com/pamelafox)
|
|
||||||
* [Using HTML5 To Power Your Game Production](http://www.blitzgamesstudios.com/blitztech/html5-presentation) by Richard Hackett
|
|
||||||
|
|
||||||
|
|
||||||
[Send me a link](http://hakim.se/about/contact) if you used reveal.js for a project or presentation.
|
|
||||||
|
|
||||||
|
|
||||||
## History
|
|
||||||
|
|
||||||
#### 1.5 (master/beta)
|
|
||||||
- New API method ```Reveal.getPreviousSlide()```
|
|
||||||
- New API method ```Reveal.getCurrentSlide()```
|
|
||||||
- New API method ```Reveal.getIndices()```
|
|
||||||
- Fixed bug where the ```.present``` class was sometimes left on the previous slide
|
|
||||||
- Added support for slides written using markdown
|
|
||||||
- Added helped method ```Reveal.getQueryHash()```
|
|
||||||
- Added EOT font for IE support
|
|
||||||
- IE8 support
|
|
||||||
- Fixed bug where hovering 3D links in Chrome caused them to disappear
|
|
||||||
- Disable 3D links in IE and more accurate CSS feature detection
|
|
||||||
- CSS is more relative in sizing to allow for low resolutions. Thanks [StereotypicalApps](https://github.com/StereotypicalApps)
|
|
||||||
- PDF export ([instructions](https://github.com/hakimel/reveal.js#pdf-export))
|
|
||||||
|
|
||||||
#### 1.4
|
|
||||||
- Main ```#reveal container``` is now selected via a class instead of ID
|
|
||||||
- API methods for adding or removing all event listeners
|
|
||||||
- The ```slidechange``` event now includes currentSlide and previousSlide
|
|
||||||
- Fixed bug where ```slidechange``` was firing twice when history was enabled
|
|
||||||
- Folder structure updates for scalability (see /lib & /plugin)
|
|
||||||
- Slide notes by [rmurphey](https://github.com/rmurphey)
|
|
||||||
- Bumped up default font-size for code samples
|
|
||||||
- Added beige theme
|
|
||||||
- Added ```autoSlide``` config
|
|
||||||
- Bug fix: The ```slidechanged``` event is now firing upon ```hashchange```. Thanks [basecode](https://github.com/basecode)
|
|
||||||
- Bug fix: JS error when the ```progress``` option was true but there was no progress DOM element
|
|
||||||
- ```keyboard``` config flag for disabling all keyboard navigation
|
|
||||||
|
|
||||||
#### 1.3
|
|
||||||
- Revised keyboard shortcuts, including ESC for overview, N for next, P for previous. Thanks [mahemoff](https://github.com/mahemoff)
|
|
||||||
- Added support for looped presentations via config
|
|
||||||
- Fixed IE9 fallback
|
|
||||||
- Added event binding methods (```Reveal.addEventListener```, ```Reveal.removeEventListener```)
|
|
||||||
- Added ```slidechanged``` event
|
|
||||||
- Added print styles. Thanks [skypanther](https://github.com/skypanther)
|
|
||||||
- The address bar now hides automatically on mobile browsers
|
|
||||||
- Space and return keys can be used to exit the overview mode
|
|
||||||
- Events for fragment states (```fragmentshown``` / ```fragmenthidden```)
|
|
||||||
- Support for swipe navigation on touch devices. Thanks [akiersky](https://github.com/akiersky)
|
|
||||||
- Support for pinch to overview on touch devices
|
|
||||||
|
|
||||||
#### 1.2
|
|
||||||
|
|
||||||
- Big changes to DOM structure:
|
|
||||||
- Previous ```#main``` wrapper is now called ```#reveal```
|
|
||||||
- Slides were moved one level deeper, into ```#reveal .slides```
|
|
||||||
- Controls and progress bar were moved into ```#reveal```
|
|
||||||
- CSS is now much more explicit, rooted at ```#reveal```, to prevent conflicts
|
|
||||||
- Config option for disabling updates to URL, defaults to true
|
|
||||||
- Anchors with image children no longer rotate in 3D on hover
|
|
||||||
- Support for mouse wheel navigation ([naugtur](https://github.com/naugtur))
|
|
||||||
- Delayed updates to URL hash to work around a bug in Chrome
|
|
||||||
- Included a ```classList``` polyfill for IE9
|
|
||||||
- Support for wireless presenter keys
|
|
||||||
- States can now be applied as classes on the document element by adding ```data-state``` on a slide
|
|
||||||
|
|
||||||
#### 1.1
|
|
||||||
|
|
||||||
- Added an optional presentation progress bar
|
|
||||||
- Images wrapped in anchors no longer unexpectedly flip in 3D
|
|
||||||
- Slides that contain other slides are given the 'stack' class
|
|
||||||
- Added ```transition``` option for specifying transition styles
|
|
||||||
- Added ```theme``` option for specifying UI styles
|
|
||||||
- New transitions: ```box``` & ```page```
|
|
||||||
- New theme: ```neon```
|
|
||||||
|
|
||||||
#### 1.0
|
|
||||||
|
|
||||||
- New and improved style
|
|
||||||
- Added controls in bottom right which indicate where you can navigate
|
|
||||||
- Reveal views in iteratively by giving them the ```.fragment``` class
|
|
||||||
- Code sample syntax highlighting thanks to [highlight.js](http://softwaremaniacs.org/soft/highlight/en/description/)
|
|
||||||
- Initialization options (toggling controls, toggling rolling links, transition theme)
|
|
||||||
|
|
||||||
#### 0.3
|
|
||||||
|
|
||||||
- Added licensing terms
|
|
||||||
- Fixed broken links on touch devices
|
|
||||||
|
|
||||||
#### 0.2
|
|
||||||
|
|
||||||
- Refactored code and added inline documentation
|
|
||||||
- Slides now have unique URL's
|
|
||||||
- A basic API to invoke navigation was added
|
|
||||||
|
|
||||||
#### 0.1
|
|
||||||
|
|
||||||
- First release
|
|
||||||
- Transitions and a white theme
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT licensed
|
MIT licensed
|
||||||
|
|
||||||
Copyright (C) 2012 Hakim El Hattab, http://hakim.se
|
Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se
|
||||||
Loading…
Reference in New Issue