Metadata-Version: 2.1
Name: lookatme
Version: 2.2.0
Summary: An interactive, command-line presentation tool
Home-page: https://github.com/d0c-s4vage/lookatme
Author: James Johnson
Author-email: d0c.s4vage@gmail.com
License: UNKNOWN
Description: [![Master Build Status](https://travis-ci.org/d0c-s4vage/lookatme.svg?branch=master)](https://travis-ci.org/d0c-s4vage/lookatme)
        [![Coverage Status](https://coveralls.io/repos/github/d0c-s4vage/lookatme/badge.svg?branch=master)](https://coveralls.io/github/d0c-s4vage/lookatme?branch=master)
        [![PyPI Statistics](https://img.shields.io/pypi/dm/lookatme)](https://pypistats.org/packages/lookatme)
        [![Latest Release](https://img.shields.io/pypi/v/lookatme)](https://pypi.python.org/pypi/lookatme/)
        [![Documentation Status](https://readthedocs.org/projects/lookatme/badge/?version=latest)](https://lookatme.readthedocs.io/en/latest/)
        
        [![Twitter Follow](https://img.shields.io/twitter/follow/d0c_s4vage?style=plastic)](https://twitter.com/d0c_s4vage)
        
        # `lookatme`
        
        `lookatme` is an interactive, extensible, terminal-based markdown presentation
        tool.
        
        ## TOC
        
        - [TOC](#toc)
        - [Features](#features)
          * [Tour](#tour)
        - [Navigating the Presentation](#navigating-the-presentation)
        - [CLI Options](#cli-options)
        - [Known Extensions](#known-extensions)
        - [Documentation](#documentation)
        
        ## Features
        
        * Markdown rendering
        * Live (input file modification time watching) and manual reloading
        * Live terminals embedded directly in slides
        * Syntax highlighting using [Pygments](https://pygments.org/)
        * Loading external files into code blocks
        * Support for contrib extensions
        * Smart slide splitting
        
        ### Tour
        
        General tour
        
        ![lookatme_tour](docs/source/_static/lookatme_tour.gif)
        
        Embedded terminal example
        
        ![terminal example](docs/source/_static/ext_terminal_example.gif)
        
        Sourcing external files example
        
        ![file loader example](docs/source/_static/ext_file_loader_example.gif)
        
        ## Navigating the Presentation
        
        | Action                         | Keys                             | Notes |
        |--------------------------------|----------------------------------|-------|
        | Next Slide                     | `l j right space`                |       |
        | Prev Slide                     | `h k left delete backspace`      |       |
        | Quit                           | `q Q`                            |       |
        | Terminal Focus                 | Click on the terminal            |       |
        | Exit Terminal                  | `ctrl+a` and then a slide action |       |
        | Vertically scroll within slide | `up/down or page up/page down`   |       |
        
        ## CLI Options
        
        ```
        Usage: lookatme [OPTIONS] [INPUT_FILES]...
        
          lookatme - An interactive, terminal-based markdown presentation tool.
        
        Options:
          --debug
          -l, --log PATH
          -t, --theme [dark|light]
          -s, --style [default|emacs|friendly|colorful|autumn|murphy|manni|monokai|perldoc|pastie|borland|trac|native|fruity|bw|vim|vs|tango|rrt|xcode|igor|paraiso-light|paraiso-dark|lovelace|algol|algol_nu|arduino|rainbow_dash|abap|solarized-dark|solarized-light|sas|stata|stata-light|stata-dark|inkpot]
          --dump-styles                   Dump the resolved styles that will be used
                                          with the presentation to stdout
        
          --live, --live-reload           Watch the input filename for modifications
                                          and automatically reload
        
          -e, --exts TEXT                 A comma-separated list of extension names to
                                          automatically load (LOOKATME_EXTS)
        
          --single, --one                 Render the source as a single slide
          --version                       Show the version and exit.
          --help                          Show this message and exit.
        ```
        
        ## Known Extensions
        
        Below is a list of known extensions for lookatme:
        
        | Extension Name | Install Name                                                                                     | Notes                                                                                                                         |
        |----------------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|
        | qrcode         | [lookatme.contrib.qrcode](https://github.com/d0c-s4vage/lookatme.contrib.qrcode)                 | Renders QR codes from code blocks                                                                                             |
        | image_ueberzug | [lookatme.contrib.image_ueberzug](https://github.com/d0c-s4vage/lookatme.contrib.image_ueberzug) | Renders images with [ueberzug](https://github.com/seebye/ueberzug) (Linux only)                                               |
        | render         | [lookatme.contrib.render](https://github.com/d0c-s4vage/lookatme.contrib.render)                 | Renders supported code blocks (graphviz and mermaid-js) by calling an external program. requires an image-rendering extension |
        
        ## Documentation
        
        See the [documentation](https://lookatme.readthedocs.io/en/latest/) for details.
        
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Environment :: Plugins
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Multimedia :: Graphics :: Presentation
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=3.6
Description-Content-Type: text/markdown
