Skip to content
Snippets Groups Projects
Commit b3f3a58c authored by Jose Torres's avatar Jose Torres
Browse files

Added main instructions for presentations

parent fb61f5b8
No related branches found
No related tags found
1 merge request!9WIP: Training presentations
# Presentations
This directory contains the basic RevealJS presentation at `revealjs-container`
which can be installed through the steps below. The `presentation-content`
directory has a list of index files that suggests content for a particular
presentation.
# Installing and Configure RevealJS
RevealJS is a presentation library that can render MarkDown as slides on your browser using JavaScript. To utilize the complete version we'll use the full setup described below.
## Pre Requisites
1. Install [Node.js](http://nodejs.org/)
2. Install [Grunt](http://gruntjs.com/getting-started#installing-the-cli)
Create a directory for your new presentation and run the following commands to setup the project. Note the data-markdown attribute on the section script.
## Full setup
1. Clone: `git clone https://github.com/hakimel/reveal.js.git`
2. Navigate to: `cd reveal.js`
3. Install. `npm install`
4. Run server: `grunt serve`
After successfully installing RevealJS edit the index.html to add each slide. For markdown we can use a section with MarkDown within a template script.
```
<section data-markdown>
<script type="text/template">
## Page title
A paragraph with some text and a [link](http://gitlab.com).
</script>
</section>
```
The recommended approach is to use external MarkDown files that point to your GLU repository and link to each md file.
>Note the separator arguments which determine how slides are delimited in the external file. The data-charset attribute is optional and specifies which charset to use when loading the external file.
It seems this library doesn't support absolute or relative urls but looks by default on the same directory its installed. To allow linking files from our University project we'll need a symlink. In my case I have that project one directory above so the command would look like this `ln -s ../University/training/` this also assumes we're in the RevealJS directory.
```
<section data-markdown="training/user_training.md"
data-separator="^\n\n\n"
data-separator-vertical="^\n\n"
data-separator-notes="^Note:"
data-charset="iso-8859-15">
</section>
```
There are also plugins that can be used such as [Chalkboard](http://courses.telematique.eu/reveal.js-plugins/chalkboard-demo.html#/) listed on the reference below.
## Reference
* https://github.com/hakimel/reveal.js
* https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware
* http://htmlcheats.com/reveal-js/reveal-js-tutorial-reveal-js-for-beginners/
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment