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 down right space
Prev Slide h k up left delete backspace
Quit q Q
Terminal Focus Click on the terminal
Exit Terminal ctrl+a and then a slide action

CLI Options

Usage: lookatme [OPTIONS] [INPUT_FILE]

  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]
  --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
  --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

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-1.1.1.tar.gz (28.1 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: lookatme-1.1.1.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.41.0 CPython/3.7.1

File hashes

Hashes for lookatme-1.1.1.tar.gz
Algorithm Hash digest
SHA256 8d9d70bfa08bfdd3415feccf9d9ea484fa94819ae161e47c146151af8d305b92
MD5 d05e60f81421e352f5f4321cf0eee72f
BLAKE2b-256 e811f399c2122826d794a73b4af94d2d4a4e182d5aacdcbbd4c220b98ac7a01a

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