Giter VIP home page Giter VIP logo

Deck-o-tron

A build-time tool for compiling HTML presentation decks.

What does it do?

Deck-o-tron makes it easier to produce HTML-based presentation decks that work with frameworks like Reveal.js. Rather than having to create and maintain a single, monolithic HTML file containing all of your presentation's slides, you can instead have individual files per slide. Deck-o-tron then takes care of assembling those individual files into the complete HTML document.

Deck-o-tron supports Nunjucks templates, HTML files and Markdown files for your slides. Templates and Markdown files will first be compiled to HTML and then inserted into the final document. For templates, you can supply context data as JSON or YAML files.

Example

Given a folder of slides like this:

slides/
 └─┬ 01-cover.nunj  # Slide as Nunjucks template
   ├ 01-cover.json  # Context data for the above slide
   │
   ├ 02-elevator-pitch.html  # Slide as HTML file
   │
   ├ 03-why-it-is-awesome.md  # Slide as MD file
   │
   ├ 04-summary.nunj  # Another Nunjucks slide
   └ 04-summary.yaml  # ...this time with YAML context data

...Deck-o-tron will produce a single index.html file containing all slides.

The order of the slides in the final deck is determined by their filenames. A simple way to control that is to prefix numbers to the filenames, as in the example above. Any other files in the same directory will be ignored by Deck-o-tron.

Deck-o-tron also supports nested groups of slides (useful, for instance, to create vertical slides in Reveal.js) and sub-folders for individual slides, which can be useful for grouping files that relate to a single slide (e.g. data and images used on that slide).

Installation and setup

  1. Install Deck-o-tron as a dependency: npm install --save-dev deckotron
  2. TBC - probably make a config file and hook deckotron into your build

Contributing

Deck-o-tron is open-source and we welcome feedback and contributions. Even small contributions like shares, likes or reporting issues are greatly appreciated!

deckotron's Projects

deckotron icon deckotron

A build-time tool for compiling HTML presentation decks.

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.