jan/revproxy-presentation
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README.md

Browse source 
readme tweaks
This commit is contained in:
Hakim El Hattab 2016-04-07 09:55:04 +02:00
parent 8789baae29
commit f98b5ccdca
1 changed files with 49 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

104
README.md
View file

@ -1,65 +1,59 @@
# reveal.js # reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js)
[![Build Status](https://travis-ci.org/hakimel/reveal.js.svg?branch=master)](https://travis-ci.org/hakimel/reveal.js)
A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/). A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
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 modern browser but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere. 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 modern browser but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
# Table of contents ## Table of contents
- [reveal.js](#revealjs) - [Online Editor](#online-editor)
- [More reading](#more-reading) - [Instructions](#instructions)
- [Online Editor](#online-editor) - [Markup](#markup)
- [Instructions](#instructions) - [Markdown](#markdown)
- [Markup](#markup) - [External Markdown](#external-markdown)
- [Markdown](#markdown) - [Element Attributes](#element-attributes)
- [External Markdown](#external-markdown) - [Slide Attributes](#slide-attributes)
- [Element Attributes](#element-attributes) - [Configuration](#configuration)
- [Slide Attributes](#slide-attributes) - [Presentation Size](#presentation-size)
- [Configuration](#configuration) - [Dependencies](#dependencies)
- [Presentation Size](#presentation-size) - [Ready Event](#ready-event)
- [Dependencies](#dependencies) - [Auto-sliding](#auto-sliding)
- [Ready Event](#ready-event) - [Keyboard Bindings](#keyboard-bindings)
- [Auto-sliding](#auto-sliding) - [Touch Navigation](#touch-navigation)
- [Keyboard Bindings](#keyboard-bindings) - [Lazy Loading](#lazy-loading)
- [Touch Navigation](#touch-navigation) - [API](#api)
- [Lazy Loading](#lazy-loading) - [Slide Changed Event](#slide-changed-event)
- [API](#api) - [Presentation State](#presentation-state)
- [Slide Changed Event](#slide-changed-event) - [Slide States](#slide-states)
- [Presentation State](#presentation-state) - [Slide Backgrounds](#slide-backgrounds)
- [Slide States](#slide-states) - [Parallax Background](#parallax-background)
- [Slide Backgrounds](#slide-backgrounds) - [Slide Transitions](#slide-transitions)
- [Parallax Background](#parallax-background) - [Internal links](#internal-links)
- [Slide Transitions](#slide-transitions) - [Fragments](#fragments)
- [Internal links](#internal-links) - [Fragment events](#fragment-events)
- [Fragments](#fragments) - [Code syntax highlighting](#code-syntax-highlighting)
- [Fragment events](#fragment-events) - [Slide number](#slide-number)
- [Code syntax highlighting](#code-syntax-highlighting) - [Overview mode](#overview-mode)
- [Slide number](#slide-number) - [Fullscreen mode](#fullscreen-mode)
- [Overview mode](#overview-mode) - [Embedded media](#embedded-media)
- [Fullscreen mode](#fullscreen-mode) - [Stretching elements](#stretching-elements)
- [Embedded media](#embedded-media) - [postMessage API](#postmessage-api)
- [Stretching elements](#stretching-elements) - [PDF Export](#pdf-export)
- [postMessage API](#postmessage-api) - [Theming](#theming)
- [PDF Export](#pdf-export) - [Speaker Notes](#speaker-notes)
- [Theming](#theming) - [Share and Print Speaker Notes](#share-and-print-speaker-notes)
- [Speaker Notes](#speaker-notes) - [Server Side Speaker Notes](#server-side-speaker-notes)
- [Share and Print Speaker Notes](#share-and-print-speaker-notes) - [Multiplexing](#multiplexing)
- [Server Side Speaker Notes](#server-side-speaker-notes) - [Master presentation](#master-presentation)
- [Multiplexing](#multiplexing) - [Client presentation](#client-presentation)
- [Master presentation](#master-presentation) - [Socket.io server](#socketio-server)
- [Client presentation](#client-presentation) - [MathJax](#mathjax)
- [Socket.io server](#socketio-server) - [Installation](#installation)
- [socket.io server as file static server](#socketio-server-as-file-static-server) - [Basic setup](#basic-setup)
- [MathJax](#mathjax) - [Full setup](#full-setup)
- [Installation](#installation) - [Folder Structure](#folder-structure)
- [Basic setup](#basic-setup) - [License](#license)
- [Full setup](#full-setup)
- [Folder Structure](#folder-structure)
- [License](#license)
#### More reading #### More reading
- [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer.
- [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history. - [Changelog](https://github.com/hakimel/reveal.js/releases): Up-to-date version history.
- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own! - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks. - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.