Skip to main content

A sphinx theme for generate reveal.js presentation. #sphinxjp

Project description

reveal.js style presentation theme for Sphinx.

travis coveralls.io downloads latest version license

Output Sample

output:

http://packages.python.org/sphinxjp.themes.revealjs/

source:

http://packages.python.org/sphinxjp.themes.revealjs/_sources/index.txt

Features

  • provide revealjs directive for reveal.js presetation slide control.

  • provide revealjs theme for render presetation.

Set up

Make environment with pip:

$ pip install sphinxjp.themes.revealjs

Make environment with easy_install:

$ easy_install sphinxjp.themes.revealjs

Convert Usage

setup conf.py with:

extensions = ['sphinxjp.themecore']
html_theme = 'revealjs'
html_use_index = False

and run:

$ make html

Writing Custom Directives

revealjs

This directive crate a slide section for reveal.js.

.. revealjs:: Heads Up

 reveal.js is a framework for easily creating beautiful presentations using HTML.
 You'll need a browser with support for CSS 3D transforms to see it in its full glory.

Slides can be nested inside of other slides,

.. revealjs::

 .. revealjs:: Vertical Slide1

  vertical slide1

 .. revealjs:: Vertical Slide2

  vertical slide2

 .. revealjs:: Vertical Slide3

  vertical slide3

rv_code

.. revealjs:: Pretty Code

 .. rv_code::

  function linkify( selector ) {
    if( supports3DTransforms ) {

      var nodes = document.querySelectorAll( selector );

      for( var i = 0, len = nodes.length; i < len; i++ ) {
        var node = nodes[i];

        if( !node.className ) ) {
          node.className += ' roll';
        }
      };
    }
  }

rv_small

This directive can be used when writing the text smaller.

.. revealjs:: rv_small smaple

 .. rv_small::

  Created by `tell-k <http://github.com/tell-k>`_ / `@tell-k <http://twitter.com/tell_k>`_

rv_note

This directive can be used when creating some notes for presenter. They’ll be hidden in your presentation, but you can see them if you open the speaker notes window (hit ‘s’ on your keyboard).

.. revealjs:: Heads Up

 reveal.js is a framework for easily creating beautiful presentations using HTML.
 You'll need a browser with support for CSS 3D transforms to see it in its full glory.

 .. rv_note::

  Oh hey, these are some notes. They'll be hidden in your presentation,
  but you can see them if you open the speaker notes window (hit 's' on your keyboard).

Requirement

  • Python 2.7 or later.

  • Sphinx 1.2.x or later.

Using

  • Reveal.js

  • jQuery 1.10.2

License

See the LICENSE file for specific terms.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxjp.themes.revealjs-0.1.1.tar.gz (276.2 kB view details)

Uploaded Source

File details

Details for the file sphinxjp.themes.revealjs-0.1.1.tar.gz.

File metadata

File hashes

Hashes for sphinxjp.themes.revealjs-0.1.1.tar.gz
Algorithm Hash digest
SHA256 83c6e5d4c0a4c64778a3e12b40199694e79cd3f50bbd1f3c4b381a3bdbb7d12a
MD5 3e5b44bc508283d98047f21a71428a48
BLAKE2b-256 eeb78305d4a7d8aff488851657a67df95572495e1a2c69e5b4f16b40af5eba87

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page