GithubHelp home page GithubHelp logo

yerko76 / asciidoctor-backends Goto Github PK

View Code? Open in Web Editor NEW

This project forked from asciidoctor/asciidoctor-backends

0.0 1.0 0.0 696 KB

Backends (i.e., templates) for Asciidoctor, a Ruby port of AsciiDoc.

Home Page: http://asciidoctor.org

License: Other

Ruby 11.26% HTML 88.74%

asciidoctor-backends's Introduction

Asciidoctor Backends

Build Status

This repository hosts an assortment of backends (i.e., templates) for Asciidoctor, a pure Ruby port of the AsciiDoc markup language.

In this repository, you’ll find replicas of both the html5 and docbook45 backends from AsciiDoc (and Asciidoctor) written in both Haml and Slim, as well as backends for generating HTML5 presentations from AsciiDoc.

General Usage Instructions

  1. Ensure Asciidoctor, Slim, Haml and their dependencies are installed:

    $ gem install asciidoctor tilt haml thread_safe
      gem install slim --version 2.1.0
    Warning
    The Slim-based templates are not yet compatible with Slim 3.
  2. Clone asciidoctor/asciidoctor-backends to get templates for rendering presentation HTML:

    $ git clone https://github.com/asciidoctor/asciidoctor-backends
  3. 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}
  4. Generate HTML from Asciidoctor templates:

    1. Command Line:

      $ asciidoctor -T TEMPLATE_DIRECTORY ${options} CONTENT_FILE
    2. Build Script: use Ruby, JavaScript, Gradle, or your favorite build tool/script with presentation options

  5. 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.
Table 1. Existing Backends Templates
Backend PRESENTATION_LIBRARY TEMPLATE_DIRECTORY

https://github.com/imakewebthings/deck.js

replaced by:
asciidoctor/asciidoctor-deck.js

https://github.com/hakimel/reveal.js

replaced by:
asciidoctor/asciidoctor-reveal.js

https://github.com/paulrouget/dzslides

asciidoctor-backends/slim/dzslides

https://github.com/markdalgleish/bespoke.js

asciidoctor-backends/slim/bespokejs

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.

asciidoctor-backends's People

Contributors

mojavelinux avatar jirutka avatar obilodeau avatar cmoulliard avatar lordofthejars avatar buuhsmead avatar robertpanzer avatar aheusingfeld avatar antoinesd avatar pilhuhn avatar houbie avatar stephane-deraco avatar danhyun avatar ggrossetie avatar lightguard avatar randybb avatar cexbrayat avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.