Asciidoc

Presentation Engine

ape logo

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

Create presentation’s structure

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

  1. Create a 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 all adoc files to the html format in the dist/ directory:

npm run build

Or run a web server with live reload:

npm start

Convert to PDF

To convert all presentations from HTML to PDF:

npm run pdf

To convert all presentations in a specific directory:

npm run pdf -- ./dist/example

To convert a single presentation:

npm run pdf -- ./dist/example/index.html

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.