8000 GitHub - d0c-s4vage/lookatme at v2.2.0
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

d0c-s4vage/lookatme

Repository files navigation

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

  -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 Renders QR codes from code blocks
image_ueberzug lookatme.contrib.image_ueberzug Renders images with ueberzug (Linux only)
render 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 for details.

0