Skip to content

Commit 850a628

Browse files
committed
Add instructions on Reveal.js
1 parent 69db1bf commit 850a628

2 files changed

Lines changed: 32 additions & 24 deletions

File tree

CONTRIBUTING.MD

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,29 @@ Please note that we will get to your comment as soon as possible but we can't co
1515

1616
In this document you will find the following sections:
1717

18-
1. [Instructions](#Instructions)
19-
2. [Cloning The Project Locally](#Cloning-The-Project-Locally)
20-
3. [Continuous Integration Testing](#Continuous-Integration-Testing)
21-
1. [CI Tests Using Docker](#CI-Tests-Using-Docker)
22-
2. [CI Tests Using NPM](#CI-Tests-Using-NPM)
23-
3. [Types Of Tests](#Types-Of-Tests)
24-
4. [Local Website](#Local-Website)
25-
5. [Jekyll Pages](#Jekyll-Pages)
26-
1. [Layout](#Layout)
27-
2. [Title](#Title)
28-
3. [Ref](#Ref)
29-
4. [Lang](#Lang)
30-
5. [Status](#Status)
31-
6. [Permalink](#Permalink)
32-
6. [Jekyll Blog Posts](#Jekyll-Blog-Posts)
33-
1. [Post Layout](#Post-Layout)
34-
2. [Author](#Author)
35-
3. [Date](#Date)
36-
4. [Last Modified](#Last-Modified)
37-
7. [Jekyll Draft Blog Posts](#Jekyll-Draft-Blog-Posts)
38-
8. [Reveal.js Presentations](#Revealjs-Presentations)
39-
9. [Hacker Slides](#Hacker-Slides)
40-
10. [Useful Docker Commands](#Useful-Docker-Commands)
18+
1. [Instructions](#instructions)
19+
2. [Cloning The Project Locally](#cloning-the-project-locally)
20+
3. [Continuous Integration Testing](#continuous-integration-testing)
21+
1. [CI Tests Using Docker](#ci-tests-using-docker)
22+
2. [CI Tests Using NPM](#ci-tests-using-npm)
23+
3. [Types Of Tests](#types-of-tests)
24+
4. [Local Website](#local-website)
25+
5. [Jekyll Pages](#jekyll-pages)
26+
1. [Layout](#layout)
27+
2. [Title](#title)
28+
3. [Ref](#ref)
29+
4. [Lang](#lang)
30+
5. [Status](#status)
31+
6. [Permalink](#permalink)
32+
6. [Jekyll Blog Posts](#jekyll-blog-posts)
33+
1. [Post Layout](#post-layout)
34+
2. [Author](#author)
35+
3. [Date](#date)
36+
4. [Last Modified](#last-modified)
37+
7. [Jekyll Draft Blog Posts](#jekyll-draft-blog-posts)
38+
8. [Reveal.js Presentations](#revealjs-presentations)
39+
9. [Hacker Slides](#hacker-slides)
40+
10. [Useful Docker Commands](#useful-docker-commands)
4141

4242
## Cloning The Project Locally
4343

@@ -370,9 +370,17 @@ Notice that we're using the same command as when we run the website locally but
370370

371371
As part of our desire to work in the open, we are leveraging [Reveal.js](https://revealjs.com/#/), an open source framework project to generate web based presentations.
372372

373-
To take a markdown file and generate a presentation on the website, you can use the following structure:
373+
To take a markdown file and generate a presentation on the website, you need to put your presentation in the `presentations` folder and the appropriate language subfolder:
374374

375+
![Presentations folders](assets/images/presentations-layout.png)
375376

377+
You can then create a link and use the following URL structure:
378+
379+
```html
380+
https://gcdevops.github.io/presentation.html?markdown=/<lang>/<filename>.md
381+
```
382+
383+
Where `lang` is the folder `en` or `fr` and `filename` is the presentation's file name.
376384

377385
## Hacker Slides
378386

81.3 KB
Loading

0 commit comments

Comments
 (0)