GithubHelp home page GithubHelp logo

evanmo / presentable Goto Github PK

View Code? Open in Web Editor NEW

This project forked from frederickf/presentable

0.0 2.0 0.0 110 KB

Adds a table of contents to HTML based presentations including Reveal.js, html5slides, Shower and impress.js

Home Page: http://fcfeibel.com/presentable/

License: BSD 2-Clause "Simplified" License

presentable's Introduction

Presentable

A Table of Contents for HTML Presentations

Presentable is a small script/plugin/widget/thingy that adds a table of contents to HTML based presentations by parsing the header tags.

See examples and detailed instructions: http://fcfeibel.com/presentable/

Framework Support

The following presentation frameworks are supported out of the box, and Presentable can theoretically handle other frameworks too, although your mileage may vary.

Browser Support

Currently Presentable has been tested and works in Firefox, Chrome, Safari, IE9/10, and the default browser on my HTC G2 Android phone.

Generic Instructions

These are generic instructions for installing. See the official documentation for presentation specific instructions.

CSS

Add the CSS in the <head> tag.

<link rel="stylesheet" href="path/to/presentable.css">

HTML

Wrap the following HTML in a slide.

<h2>Table of Contents</h2>
<nav id="presentable-toc" class="frameworkname"></nav>

And add this as a child of the <body> tag.

<aside id="presentable-icon" class="frameworkname">
    <a title="Table of Contents" href="#?">
        <img alt="Table of Contents" src="path/to/frameworkname.png"/>
    </a>
</aside>

JavaScript

Reference presentable.js following the conventions set by your framework of choice.

<script src="path/to/presentable.js"></script>

Initialize

This goes after all the slides.

presentable.toc({
    framework: "framework name here"
});

It can also accept other configuration options allowing Presentable to support almost any framework.

presentable.toc({
    config: "options here"
});

Learn More

See examples and instructions: http://fcfeibel.com/presentable/

presentable's People

Contributors

ffeibel avatar

Watchers

 avatar  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.