The Teachers' Asciidoctor Starter Kit

This repo enables you to create:

• A base HTML/PDF of your notes and other teaching materials

• A handout version (by using the pre-processor ifdef::handout)

• A revealjs presentation of the file

In order to fully achieve the potential of this repo, you’ll want to be familiar with:

• Asciidoctor

• Asciidoctor-Revealjs

• LaTeX tikz syntax (for diagrams in tikz)

A simple start

If you just want the simple stylesheet, without any of the extras, you can simply just grab the stylesheet in stylesheets/simple.css and:

1. Copy simple.css to the location of your file.adoc,

2. Put :stylesheet: simple.css in your file.adoc file,

3. Run asciidoctor file.adoc.

Requirements

• asciidoctor executable

Full start

src/example.adoc contains a comprehensive source file to create:

Requirements

• asciidoctor executable

• ruby and ruby bundle

• chromium browser (to enable PDF generation)

Steps

1. Clone: git clone https://github.com/majamin/asciidoctor-teacher-kit

2. cd asciidoctor-teacher-kit

3. bundle install

4. make

Build files will compile in the build directory.

Note	you can create any hierarchy of files in the src directory - the build files will structure themselves accordingly.

Watch and show

If you’re in a tmux session, running watch-and-show.sh can load a nice dev environment, but is not necessary to be able to use this project. Running the script creates new windows in the current session to be able to monitor the live build and show.

Requirements

• All of the above, and

• browser-sync and nodemon installed via npm,

• tmux

Preview

See examples in the examples folder.