Skip to main content

An interactive, command-line presentation tool

Project description

Master Build Status Coverage Status PyPI Statistics Latest Release Documentation Status

Twitter Follow

lookatme

lookatme is an interactive, extensible, terminal-based markdown presentation tool.

TOC

Features

  • Markdown rendering
  • Live (input file modification time watching) and manual reloading
  • Live terminals embedded directly in slides
  • Syntax highlighting using Pygments
  • Loading external files into code blocks
  • Support for contrib extensions
  • Smart slide splitting

Tour

General tour

lookatme_tour

Embedded terminal example

terminal example

Sourcing external files example

file loader example

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

  --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 Url
qrcode lookatme.contrib.qrcode https://github.com/d0c-s4vage/lookatme.contrib.qrcode
image_ueberzug lookatme.contrib.image_ueberzug https://github.com/d0c-s4vage/lookatme.contrib.image_ueberzug

Documentation

See the documentation for details.

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

lookatme-2.1.0.tar.gz (31.3 kB view details)

Uploaded Source

File details

Details for the file lookatme-2.1.0.tar.gz.

File metadata

  • Download URL: lookatme-2.1.0.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.1

File hashes

Hashes for lookatme-2.1.0.tar.gz
Algorithm Hash digest
SHA256 d536098d5933a85eb8ff63be509c6bc1b9895a4632317771700cbfddbd179b49
MD5 56bbf300c0a248ff84dff3ea16588125
BLAKE2b-256 a37262995db2a7431e23fe352cd80aefc56f1f376b408db75fced2789752daad

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