Skip to content

Commit c35cce5

Browse files
authored
Merge pull request #2231 from esthor/patch-1
bring install instructions to top, as is tradition
2 parents 436b41a + ed581ad commit c35cce5

File tree

1 file changed

+54
-54
lines changed

1 file changed

+54
-54
lines changed

README.md

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ reveal.js comes with a broad range of features including [nested slides](https:/
88
## Table of contents
99

1010
- [Online Editor](#online-editor)
11+
- [Installation](#installation)
12+
- [Basic setup](#basic-setup)
13+
- [Full setup](#full-setup)
14+
- [Folder Structure](#folder-structure)
1115
- [Instructions](#instructions)
1216
- [Markup](#markup)
1317
- [Markdown](#markdown)
@@ -48,10 +52,6 @@ reveal.js comes with a broad range of features including [nested slides](https:/
4852
- [Client presentation](#client-presentation)
4953
- [Socket.io server](#socketio-server)
5054
- [MathJax](#mathjax)
51-
- [Installation](#installation)
52-
- [Basic setup](#basic-setup)
53-
- [Full setup](#full-setup)
54-
- [Folder Structure](#folder-structure)
5555
- [License](#license)
5656

5757
#### More reading
@@ -67,6 +67,56 @@ reveal.js comes with a broad range of features including [nested slides](https:/
6767
Presentations are written using HTML or Markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at [https://slides.com](https://slides.com?ref=github).
6868

6969

70+
## Installation
71+
72+
The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
73+
74+
### Basic setup
75+
76+
The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.
77+
78+
1. Download the latest version of reveal.js from <https://github.com/hakimel/reveal.js/releases>
79+
2. Unzip and replace the example contents in index.html with your own
80+
3. Open index.html in a browser to view it
81+
82+
### Full setup
83+
84+
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.
85+
86+
1. Install [Node.js](http://nodejs.org/) (4.0.0 or later)
87+
88+
1. Clone the reveal.js repository
89+
```sh
90+
$ git clone https://github.com/hakimel/reveal.js.git
91+
```
92+
93+
1. Navigate to the reveal.js folder
94+
```sh
95+
$ cd reveal.js
96+
```
97+
98+
1. Install dependencies
99+
```sh
100+
$ npm install
101+
```
102+
103+
1. Serve the presentation and monitor source files for changes
104+
```sh
105+
$ npm start
106+
```
107+
108+
1. Open <http://localhost:8000> to view your presentation
109+
110+
You can change the port by using `npm start -- --port=8001`.
111+
112+
### Folder Structure
113+
114+
- **css/** Core styles without which the project does not function
115+
- **js/** Like above but for JavaScript
116+
- **plugin/** Components that have been developed as extensions to reveal.js
117+
- **lib/** All other third party assets (JavaScript, CSS, fonts)
118+
119+
70120
## Instructions
71121

72122
### Markup
@@ -1252,56 +1302,6 @@ Reveal.initialize({
12521302
Read MathJax's documentation if you need [HTTPS delivery](http://docs.mathjax.org/en/latest/start.html#secure-access-to-the-cdn) or serving of [specific versions](http://docs.mathjax.org/en/latest/configuration.html#loading-mathjax-from-the-cdn) for stability.
12531303
12541304
1255-
## Installation
1256-
1257-
The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
1258-
1259-
### Basic setup
1260-
1261-
The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.
1262-
1263-
1. Download the latest version of reveal.js from <https://github.com/hakimel/reveal.js/releases>
1264-
2. Unzip and replace the example contents in index.html with your own
1265-
3. Open index.html in a browser to view it
1266-
1267-
### Full setup
1268-
1269-
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.
1270-
1271-
1. Install [Node.js](http://nodejs.org/) (4.0.0 or later)
1272-
1273-
1. Clone the reveal.js repository
1274-
```sh
1275-
$ git clone https://github.com/hakimel/reveal.js.git
1276-
```
1277-
1278-
1. Navigate to the reveal.js folder
1279-
```sh
1280-
$ cd reveal.js
1281-
```
1282-
1283-
1. Install dependencies
1284-
```sh
1285-
$ npm install
1286-
```
1287-
1288-
1. Serve the presentation and monitor source files for changes
1289-
```sh
1290-
$ npm start
1291-
```
1292-
1293-
1. Open <http://localhost:8000> to view your presentation
1294-
1295-
You can change the port by using `npm start -- --port=8001`.
1296-
1297-
### Folder Structure
1298-
1299-
- **css/** Core styles without which the project does not function
1300-
- **js/** Like above but for JavaScript
1301-
- **plugin/** Components that have been developed as extensions to reveal.js
1302-
- **lib/** All other third party assets (JavaScript, CSS, fonts)
1303-
1304-
13051305
## License
13061306
13071307
MIT licensed

0 commit comments

Comments
 (0)