[](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 `<!-- stop -->` comments between block elements
### Tutorial
```bash
pip install --upgrade lookatme
lookatme --tutorial
```
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/v2.5.5 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/d0c-s4vage/lookatme",
"name": "lookatme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "James Johnson",
"author_email": "d0c.s4vage@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/26/b4/c17b39f5266995218c300d60aeb49bab6df23624b8b84c74711f28f3bc07/lookatme-2.5.5.tar.gz",
"platform": null,
"description": "[](https://travis-ci.org/d0c-s4vage/lookatme)\n[](https://coveralls.io/github/d0c-s4vage/lookatme?branch=master)\n[](https://pypistats.org/packages/lookatme)\n[](https://pypi.python.org/pypi/lookatme/)\n[](https://lookatme.readthedocs.io/en/latest/)\n\n[](https://twitter.com/d0c_s4vage)\n\n# `lookatme`\n\n`lookatme` is an interactive, extensible, terminal-based markdown presentation\ntool.\n\n## TOC\n\n- [TOC](#toc)\n- [Features](#features)\n * [Tour](#tour)\n- [Navigating the Presentation](#navigating-the-presentation)\n- [CLI Options](#cli-options)\n- [Known Extensions](#known-extensions)\n- [Documentation](#documentation)\n\n## Features\n\n* Markdown rendering\n* Built-in tutorial slides `lookatme --tutorial`\n* Live (input file modification time watching) and manual reloading\n* Live terminals embedded directly in slides\n* Syntax highlighting using [Pygments](https://pygments.org/)\n* Loading external files into code blocks\n* Support for contrib extensions\n* Smart slide splitting\n* Progressive slides with `<!-- stop -->` comments between block elements\n\n### Tutorial\n\n```bash\npip install --upgrade lookatme\nlookatme --tutorial\n```\n\nGeneral tour\n\n\n\nEmbedded terminal example\n\n\n\nSourcing external files example\n\n\n\n## Navigating the Presentation\n\n| Action | Keys | Notes |\n|--------------------------------|----------------------------------|-------|\n| Next Slide | `l j right space` | |\n| Prev Slide | `h k left delete backspace` | |\n| Quit | `q Q` | |\n| Terminal Focus | Click on the terminal | |\n| Exit Terminal | `ctrl+a` and then a slide action | |\n| Vertically scroll within slide | `up/down or page up/page down` | |\n\n## CLI Options\n\n```\nUsage: lookatme [OPTIONS] [INPUT_FILES]...\n\n lookatme - An interactive, terminal-based markdown presentation tool.\n\n See https://lookatme.readthedocs.io/en/v2.5.5 for documentation\n\nOptions:\n --debug\n -l, --log PATH\n --tutorial TEXT As a flag: show all tutorials. With a\n value/comma-separated values: show the\n specific tutorials. Use the value 'help' for\n more help\n -t, --theme [dark|light]\n --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]\n --dump-styles Dump the resolved styles that will be used\n with the presentation to stdout\n --live, --live-reload Watch the input filename for modifications\n and automatically reload\n -s, --safe Do not load any new extensions specified in\n the source markdown. Extensions specified\n via env var or -e are still loaded\n --no-ext-warn Load new extensions specified in the source\n markdown without warning\n -i, --ignore-ext-failure Ignore load failures of extensions\n -e, --exts TEXT A comma-separated list of extension names to\n automatically load (LOOKATME_EXTS)\n --single, --one Render the source as a single slide\n --version Show the version and exit.\n --help Show this message and exit.\n```\n\n## Known Extensions\n\nBelow is a list of known extensions for lookatme:\n\n| Extension Name | Install Name | Notes |\n|----------------|--------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| qrcode | [lookatme.contrib.qrcode](https://github.com/d0c-s4vage/lookatme.contrib.qrcode) | Renders QR codes from code blocks |\n| 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) |\n| 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 |\n\n## Documentation\n\nSee the [documentation](https://lookatme.readthedocs.io/en/latest/) for details.\n",
"bugtrack_url": null,
"license": "",
"summary": "An interactive, command-line presentation tool",
"version": "2.5.5",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68d920c05ba9f6255f6cad14bf581cd0970c24f9e6c8343b99ff11dcc5d83ccb",
"md5": "93c7200dd3d0133475f89b57e97e30bb",
"sha256": "c32f4a1e979082edb9156fd92a9d65cc0badaeac95cf2f9022c1b38f88ff6551"
},
"downloads": -1,
"filename": "lookatme-2.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93c7200dd3d0133475f89b57e97e30bb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 42504,
"upload_time": "2022-12-30T04:39:26",
"upload_time_iso_8601": "2022-12-30T04:39:26.493189Z",
"url": "https://files.pythonhosted.org/packages/68/d9/20c05ba9f6255f6cad14bf581cd0970c24f9e6c8343b99ff11dcc5d83ccb/lookatme-2.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "26b4c17b39f5266995218c300d60aeb49bab6df23624b8b84c74711f28f3bc07",
"md5": "89782d5c1a82dce588ce0128b475cfe7",
"sha256": "6e59813cd6bdc69e82dd7a79bb2ac1ae82889e9343c499d6bb18f77a85242deb"
},
"downloads": -1,
"filename": "lookatme-2.5.5.tar.gz",
"has_sig": false,
"md5_digest": "89782d5c1a82dce588ce0128b475cfe7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 43580,
"upload_time": "2022-12-30T04:39:27",
"upload_time_iso_8601": "2022-12-30T04:39:27.841292Z",
"url": "https://files.pythonhosted.org/packages/26/b4/c17b39f5266995218c300d60aeb49bab6df23624b8b84c74711f28f3bc07/lookatme-2.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-30 04:39:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "d0c-s4vage",
"github_project": "lookatme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "marshmallow",
"specs": [
[
">=",
"3.17.0"
],
[
"<",
"4"
]
]
},
{
"name": "Click",
"specs": [
[
">=",
"7"
],
[
"<",
"9"
]
]
},
{
"name": "PyYAML",
"specs": [
[
">=",
"5"
],
[
"<",
"6"
]
]
},
{
"name": "mistune",
"specs": [
[
">=",
"0.8"
],
[
"<",
"1"
]
]
},
{
"name": "urwid",
"specs": [
[
">=",
"2"
],
[
"<",
"3"
]
]
},
{
"name": "Pygments",
"specs": [
[
">=",
"2"
],
[
"<",
"3"
]
]
}
],
"tox": true,
"lcname": "lookatme"
}
JSON
