Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/d0c-s4vage/lookatme
An interactive, terminal-based markdown presenter
https://github.com/d0c-s4vage/lookatme
ansii command-line markdown markdown-slides markdown-viewer python slides terminal theme
Last synced: 2 days ago
JSON representation
An interactive, terminal-based markdown presenter
- Host: GitHub
- URL: https://github.com/d0c-s4vage/lookatme
- Owner: d0c-s4vage
- License: mit
- Created: 2019-11-29T00:28:28.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-02T20:22:15.000Z (10 months ago)
- Last Synced: 2025-01-17T00:06:31.400Z (9 days ago)
- Topics: ansii, command-line, markdown, markdown-slides, markdown-viewer, python, slides, terminal, theme
- Language: Python
- Homepage: https://lookatme.readthedocs.io/en/latest/
- Size: 12.1 MB
- Stars: 2,152
- Watchers: 13
- Forks: 63
- Open Issues: 37
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-browserless - lookatme - An interactive, terminal-based markdown presenter (Office work / Misc)
- project-awesome - d0c-s4vage/lookatme - An interactive, terminal-based markdown presenter (Python)
README
[](https://travis-ci.org/d0c-s4vage/lookatme)
[](https://coveralls.io/github/d0c-s4vage/lookatme?branch=master)
[](https://pypistats.org/packages/lookatme)
[](https://pypi.python.org/pypi/lookatme/)
[](https://lookatme.readthedocs.io/en/latest/)
[](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
* Built-in tutorial slides `lookatme --tutorial`
* 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
* Progressive slides with `` comments between block elements
### Tutorial
```bash
pip install --upgrade lookatme
lookatme --tutorial
```
**NOTE**: [lookatme 3.0](https://github.com/d0c-s4vage/lookatme/milestone/1) is nearing completion! Check out the latest release
candidate with: `pip install --upgrade --pre lookatme`. Be warned, version 3.0
may not be as stable and contains breaking changes (mostly with styles) from
previous major versions.
General tour
Embedded terminal example
Sourcing external files 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.
See https://lookatme.readthedocs.io/en/v{{VERSION}} for documentation
Options:
--debug
-l, --log PATH
--tutorial TEXT As a flag: show all tutorials. With a
value/comma-separated values: show the
specific tutorials. Use the value 'help' for
more help
-t, --theme [dark|light]
--style [default|emacs|friendly|friendly_grayscale|colorful|autumn|murphy|manni|material|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|staroffice|stata|stata-light|stata-dark|inkpot|zenburn|gruvbox-dark|gruvbox-light|dracula|one-dark|lilypond|nord|nord-darker|github-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
-s, --safe Do not load any new extensions specified in
the source markdown. Extensions specified
via env var or -e are still loaded
--no-ext-warn Load new extensions specified in the source
markdown without warning
-i, --ignore-ext-failure Ignore load failures of extensions
-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.