Skip to content
Snippets Groups Projects
README.md 40.4 KiB
Newer Older
  • Learn to ignore specific revisions
  • Hakim El Hattab's avatar
    Hakim El Hattab committed
    1. Download the latest version of reveal.js from <https://github.com/hakimel/reveal.js/releases>
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    2. Unzip and replace the example contents in index.html with your own
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    
    3. Open index.html in a browser to view it
    
    
    ### Full setup
    
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    Some reveal.js features, like external Markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    
    1. Install [Node.js](http://nodejs.org/)
    
    2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
    
    
    4. Clone the reveal.js repository
    
       ```sh
       $ git clone https://github.com/hakimel/reveal.js.git
       ```
    
    5. Navigate to the reveal.js folder
    
    6. Install dependencies
    
    7. Serve the presentation and monitor source files for changes
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    8. Open <http://localhost:8000> to view your presentation
    
       You can change the port by using `grunt serve --port 8001`.
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    
    ### 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)
    
    
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    
    MIT licensed
    
    
    Hakim El Hattab's avatar
    Hakim El Hattab committed
    Copyright (C) 2015 Hakim El Hattab, http://hakim.se