This repository hosts an assortment of backends (i.e., templates) for Asciidoctor, a pure Ruby port of the AsciiDoc markup language.
-
Ensure Asciidoctor, Slim, Haml and their dependencies are installed:
$ gem install asciidoctor tilt haml thread_safe gem install slim --version 2.1.0
WarningThe Slim-based templates are not yet compatible with Slim 3. -
Clone
asciidoctor/asciidoctor-backends
to get templates for rendering presentation HTML:$ git clone https://github.com/asciidoctor/asciidoctor-backends
-
Edit
CONTENT_FILE
( *.adoc or *.ad or …):-
Slides & content per slide
-
[Optional] Set presentation "options" at top of
CONTENT_FILE
. The options available & their values will depend on presentation library (some examples below).:${Attribute}: ${Value}
-
-
Generate HTML from Asciidoctor templates:
-
Command Line:
$ asciidoctor -T TEMPLATE_DIRECTORY ${options} CONTENT_FILE
-
Build Script: use Ruby, JavaScript, Gradle, or your favorite build tool/script with presentation options
-
-
Copy or clone presentation library (to output destination/branch):
$ git clone PRESENTATION_LIBRARY
Tip
|
If you are using GitHub Pages, plan ahead by keeping your source files on master branch and all output files on the gh-pages branch.
|
Backend | PRESENTATION_LIBRARY |
TEMPLATE_DIRECTORY |
---|---|---|
replaced by: |
||
replaced by: |
||
|
||
|
Note
|
Some backends may be broken out into new repositories in order to manage releases independently (and potentially publish separate gems). Aggregation of those releases back into this project may be delayed. |
Copyright © 2012-2016 Dan Allen and the Asciidoctor Project. Free use of this software is granted under the terms of the MIT License.
See the LICENSE file for details.