Metadata-Version: 2.1
Name: revelation
Version: 0.2.0
Summary: Make awesome reveal.js presentations with revelation
Home-page: https://github.com/humrochagf/revelation
Author: Humberto Rocha
Author-email: humrochagf@gmail.com
License: MIT
Description: Revelation
        ==========
        
        |PyPI| |PyPI - License| |PyPI - Python Version| |Build Status| |Coverage
        Status|
        
        `revelation <https://github.com/humrochagf/revelation>`__ makes your
        `reveal.js <https://github.com/hakimel/reveal.js>`__ presentations
        without the need to edit a monolithic html file using markdown and
        serving it localy.
        
        Installation
        ------------
        
        You can install it from the PyPI:
        
        .. code:: shell
        
            $ pip install revelation
        
        Usage
        -----
        
        Install/Update reveal.js files
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        The first thing that you will do after installing revelation is to
        download and install reveal.js to render the presentations.
        
        To do that just run the ``installreveal`` command:
        
        .. code:: shell
        
            $ revelation installreveal
        
        Running the Presentation
        ~~~~~~~~~~~~~~~~~~~~~~~~
        
        To start your presentation run:
        
        .. code:: shell
        
            $ revelation start PRESENTATION
        
        The ``PRESENTATION`` is the path to the markdown presentation file.
        
        Creating a new Presentation
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        To create a new presentation run:
        
        .. code:: shell
        
            $ revelation mkpresentation NAME
        
        That will create a new presentation folder with the ``NAME`` passed.
        
        PDF Export
        ~~~~~~~~~~
        
        Presentations can be exported to PDF via a special print stylesheet.
        This feature will be described using `Google
        Chrome <https://google.com/chrome>`__ or
        `Chromium <https://www.chromium.org/Home>`__, but I got the same results
        using `Firefox <https://www.mozilla.org/en-US/firefox/new/>`__.
        
        1. Run the presentation with revelation.
        2. Open your brownser with the ``print-pdf`` as query string like :
           ``localhost:5000/?print-pdf``.
        3. Open the in-browser print dialog (CTRL+P or CMD+P).
        4. Change the **Destination** setting to **Save as PDF**.
        5. Change the **Layout** to **Landscape**.
        6. Change the **Margins** to **None**.
        7. Enable the **Background graphics** option.
        8. Click **Save**.
        
        Alternatively you can use the
        `decktape <https://github.com/astefanutti/decktape>`__ project.
        
        Share your presentation using `Ngrok <https://ngrok.com/>`__
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        You can easily share your presentation using
        `Ngrok <https://ngrok.com/>`__. Download it, and put the binary file at
        root. Then you can do :
        
        .. code:: shell
        
            $ ngrok http 5000
        
        This assume ``5000`` is your localhost. ``ngrok`` will create a secure
        tunnel to your localhost :
        
        .. code:: shell
        
            ngrok by @inconshreveable                                              (Ctrl+C to quit)
        
            Tunnel Status                 online
            Version                       2.0.19/2.1.1
            Web Interface                 http://127.0.0.1:4040
            Forwarding                    http://323744c6.ngrok.io -> localhost:5000
            Forwarding                    https://323744c6.ngrok.io -> localhost:5000
        
            Connections                   ttl     opn     rt1     rt5     p50     p90
                                          0       0       0.00    0.00    0.00    0.00
        
        Presentation Setup
        ------------------
        
        The revelation checks for three things on your presentation folder.
        
        The 'slides.md' File
        ~~~~~~~~~~~~~~~~~~~~
        
        This is your presentation file written using markdown with some especial
        tags described on `markdown section <#markdown>`__ and is placed on your
        presentation root folder.
        
        Split your slides by setting up a *slide separator* into
        **REVEAL\_CONFIG**. Default separator is ``---``.
        
        The 'media' folder
        ~~~~~~~~~~~~~~~~~~
        
        All images used on your presentation are placed inside the **'media'**
        folder and referenced on your slides starting from your presentation
        root.
        
        .. code:: md
        
            ![Python Logo](img/python.png)
        
        The 'theme' folder
        ~~~~~~~~~~~~~~~~~~
        
        You can create your custom theme file and place it inside a **'theme'**
        folder and reference it at the configuration file.
        
        The 'config.py' File
        ~~~~~~~~~~~~~~~~~~~~
        
        The configuration file are placed on the presentation root folder and is
        responsible to customize your presentation.
        
        This file is optional and can the values above can be changed:
        
        **REVEAL\_META**: python dictionary with metadata from the presentation
        
        .. code:: python
        
            REVEAL_META = {
                # Title of the slide
                'title': 'The title',
        
                # Author in the metadata of the slide
                'author': 'Some Author',
        
                # Description in the metadata of the slide
                'description': 'Some description'
            }
        
        **REVEAL\_THEME**: string with reveal theme of choice
        
        .. code:: python
        
            # Themes
            # beige, black, blood, league, moon, night, serif, simple, sky,
            # solarized, white
            REVEAL_THEME = 'black'
        
        **REVEAL\_CONFIG**: python dictionary with the `reveal.js configuration
        attributes <https://github.com/hakimel/reveal.js/#configuration>`__ but
        using python types (e.g.: true is python boolean True)
        
        .. code:: python
        
            REVEAL_CONFIG = {
                # Slide separator
                'slideSep': '---',
        
                # Display controls in the bottom right corner
                'controls': True,
        
                # Display a presentation progress bar
                'progress': True,
        
                # Display the page number of the current slide
                'slideNumber': False,
        
                # Push each slide change to the browser history
                'history': True,
        
                # Enable keyboard shortcuts for navigation
                'keyboard': True,
        
                # Enable the slide overview mode
                'overview': True,
        
                # Vertical centering of slides
                'center': True,
        
                # Enables touch navigation on devices with touch input
                'touch': True,
        
                # Loop the presentation
                'loop': False,
        
                # Change the presentation direction to be RTL
                'rtl': False,
        
                # Turns fragments on and off globally
                'fragments': True,
        
                # Flags if the presentation is running in an embedded mode,
                # i.e. contained within a limited portion of the screen
                'embedded': False,
        
                # Flags if we should show a help overlay when the questionmark
                # key is pressed
                'help': True,
        
                # Flags if speaker notes should be visible to all viewers
                'showNotes': False,
        
                # Number of milliseconds between automatically proceeding to the
                # next slide, disabled when set to 0, this value can be overwritten
                # by using a data-autoslide attribute on your slides
                'autoSlide': 0,
        
                # Stop auto-sliding after user input
                'autoSlideStoppable': True,
        
                # Enable slide navigation via mouse wheel
                'mouseWheel': False,
        
                # Hides the address bar on mobile devices
                'hideAddressBar': True,
        
                # Opens links in an iframe preview overlay
                'previewLinks': False,
        
                # Transition style
                # default/cube/page/concave/zoom/linear/fade/none
                'transition': 'default',
        
                # Transition speed
                'transitionSpeed': 'default',  # default/fast/slow
        
                # Transition style for full page slide backgrounds
                # default/none/slide/concave/convex/zoom
                'backgroundTransition': 'default',
        
                # Number of slides away from the current that are visible
                'viewDistance': 3,
        
                # Parallax background image
                # e.g.:
                # "'https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg'"
                'parallaxBackgroundImage': '',
        
                # Parallax background size
                'parallaxBackgroundSize': '',  # CSS syntax, e.g. "2100px 900px"
        
                # Amount to move parallax background (horizontal and vertical)
                # on slide change
                # Number, e.g. 100
                'parallaxBackgroundHorizontal': '',
                'parallaxBackgroundVertical': '',
            }
        
        Markdown
        --------
        
        The markdown used on the presentation files support most of the `GitHub
        Markdown <https://help.github.com/articles/markdown-basics>`__ and adds
        some especial html comment tags to edit styles and control effects that
        are explained on the `reveal.js markdown
        docs <https://github.com/hakimel/reveal.js/#markdown>`__.
        
        **Important:** You can use all html tags on the presentation files, but
        some block tags can present unexpected behavior.
        
        .. |PyPI| image:: https://img.shields.io/pypi/v/revelation.svg
           :target: https://pypi.org/project/revelation/
        .. |PyPI - License| image:: https://img.shields.io/pypi/l/revelation.svg
           :target: https://pypi.org/project/revelation/
        .. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/revelation.svg
           :target: https://pypi.org/project/revelation/
        .. |Build Status| image:: https://travis-ci.org/humrochagf/revelation.svg?branch=master
           :target: https://travis-ci.org/humrochagf/revelation
        .. |Coverage Status| image:: https://coveralls.io/repos/github/humrochagf/revelation/badge.svg?branch=master
           :target: https://coveralls.io/github/humrochagf/revelation?branch=master
        
Keywords: presentation,slides,reveal.js,markdown
Platform: any
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Text Processing :: Markup :: HTML
Provides-Extra: test
