Skip to content
Snippets Groups Projects
README.md 40.1 KiB
Newer Older
  • Learn to ignore specific revisions
  • 2. Unzip and replace the example contents in index.html with your own
    
    3. Open index.html in a browser to view it
    
    
    ### Full setup
    
    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.
    
    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
       ```sh
       $ cd reveal.js
       ```
    
    6. Install dependencies
       ```sh
       $ npm install
       ```
    
    7. Serve the presentation and monitor source files for changes
       ```sh
       $ grunt serve
       ```
    
    8. Open <http://localhost:8000> to view your presentation
    
       You can change the port by using `grunt serve --port 8001`.
    
    
    ### 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)
    
    
    ## License
    
    MIT licensed
    
    Copyright (C) 2015 Hakim El Hattab, http://hakim.se