Asciidoc: Presentation Engine

Getting started

• ❏ Clone the repo

• ❏ Install dependencies

• ❏ Create presentation’s structure

• ❏ Create presentation’s slides

• ❏ Build it and check it locally

• ❏ Push your changes to the repo

• ❏ Enjoy

Clone the repo

git clone https://github.com/nix-united/ape.git

Install dependencies

Install the package and any packages that it depends on:

npm install

Under hood

Create symlink to the /node_modules/reveal.js/ script directory.

It should be does by the postinstall hook:

ln -s `pwd`/node_modules/reveal.js/ ./javascripts/reveal.js

Create presentation’s structure

`-- engine/
    |-- example/
    |-- my presentation/ (1)
    |   |-- images/ (2)
    |   |-- .settings.adoc (3)
    |   `-- index.adoc (4)
    |-- .contents.adoc (5)
    |-- ...
    |-- README.adoc
    `-- server.js

1. Create directory for your presentation

2. Create subdirectory images if you need it

3. Create .settings.adoc file for reveal.js configuration

4. Create index.adoc file for your presentation. Include settings in the presentation file include::.settings.adoc[]

5. Add the link to your presentations to .contents.adoc file (optional)

Create presentation’s slides

Create your presentation slides uses asciidoc format with reveal.js features.

You can see our presentation for more examples of the slides.

Live demo is also available here https://nix-united.github.io/ape/

Build and review

Convert the adoc file to the html format and check the result manually in your browser:

npm run build ./index.adoc

Or run a web server that will observe changes in the file and refresh the browser automatically:

npm start
# or
npm start ./example/index.adoc

Convert to PDF

To convert presentation’s slides from HTML to PDF, run the following command:

npm run pdf ./index.html ./index.pdf

Push your changes

git add --all
git commit -m "My first presentation with APE"
git push

Enjoy

So, you can build your presentation locally or download artifacts from the project pipeline.