{"id":13468383,"url":"https://github.com/d0c-s4vage/lookatme","last_synced_at":"2025-05-14T19:08:00.896Z","repository":{"id":39251367,"uuid":"224748938","full_name":"d0c-s4vage/lookatme","owner":"d0c-s4vage","description":"An interactive, terminal-based markdown presenter","archived":false,"fork":false,"pushed_at":"2024-04-02T20:22:15.000Z","size":12717,"stargazers_count":2197,"open_issues_count":38,"forks_count":63,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-05-14T19:07:56.322Z","etag":null,"topics":["ansii","command-line","markdown","markdown-slides","markdown-viewer","python","slides","terminal","theme"],"latest_commit_sha":null,"homepage":"https://lookatme.readthedocs.io/en/latest/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/d0c-s4vage.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-29T00:28:28.000Z","updated_at":"2025-05-09T08:42:47.000Z","dependencies_parsed_at":"2024-06-19T00:25:59.396Z","dependency_job_id":"21047974-1ba9-4078-8e00-c4ba501bb5af","html_url":"https://github.com/d0c-s4vage/lookatme","commit_stats":{"total_commits":149,"total_committers":4,"mean_commits":37.25,"dds":0.02684563758389258,"last_synced_commit":"c05abe1804d93254e9139039937eed43fb6b49ab"},"previous_names":[],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d0c-s4vage%2Flookatme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d0c-s4vage%2Flookatme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d0c-s4vage%2Flookatme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/d0c-s4vage%2Flookatme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/d0c-s4vage","download_url":"https://codeload.github.com/d0c-s4vage/lookatme/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254209859,"owners_count":22032897,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ansii","command-line","markdown","markdown-slides","markdown-viewer","python","slides","terminal","theme"],"created_at":"2024-07-31T15:01:09.874Z","updated_at":"2025-05-14T19:07:59.950Z","avatar_url":"https://github.com/d0c-s4vage.png","language":"Python","funding_links":[],"categories":["Python","Office work","ASCII"],"sub_categories":["Misc"],"readme":"[![Master Build Status](https://travis-ci.org/d0c-s4vage/lookatme.svg?branch=master)](https://travis-ci.org/d0c-s4vage/lookatme)\n[![Coverage Status](https://coveralls.io/repos/github/d0c-s4vage/lookatme/badge.svg?branch=master)](https://coveralls.io/github/d0c-s4vage/lookatme?branch=master)\n[![PyPI Statistics](https://img.shields.io/pypi/dm/lookatme)](https://pypistats.org/packages/lookatme)\n[![Latest Release](https://img.shields.io/pypi/v/lookatme)](https://pypi.python.org/pypi/lookatme/)\n[![Documentation Status](https://readthedocs.org/projects/lookatme/badge/?version=latest)](https://lookatme.readthedocs.io/en/latest/)\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/d0c_s4vage?style=plastic)](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 `\u003c!-- stop --\u003e` comments between block elements\n\n### Tutorial\n\n```bash\npip install --upgrade lookatme\nlookatme --tutorial\n```\n\n**NOTE**: [lookatme 3.0](https://github.com/d0c-s4vage/lookatme/milestone/1) is nearing completion! Check out the latest release\ncandidate with: `pip install --upgrade --pre lookatme`. Be warned, version 3.0\nmay not be as stable and contains breaking changes (mostly with styles) from\nprevious major versions.\n\nGeneral tour\n\n![lookatme_tour](docs/source/_static/lookatme_tour.gif)\n\nEmbedded terminal example\n\n![terminal example](docs/source/_static/ext_terminal_example.gif)\n\nSourcing external files example\n\n![file loader example](docs/source/_static/ext_file_loader_example.gif)\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/v{{VERSION}} 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd0c-s4vage%2Flookatme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fd0c-s4vage%2Flookatme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fd0c-s4vage%2Flookatme/lists"}