A Terminal-based Markdown Slide Presenter.
Project description
slidec
A simple python tool to present markdown in your terminal as slides.
Useful if you are wanting to do demos from the command line and refer to notes.
Works well with tmux (etc.) split planes, one for live demo, one for the slides/notes.
Option to fuzzy search and jump to selected slide if
fzf is installed.
Slide Format
Slides are written in a single markdown file separated by ---.
E.g.
# Example slide 1
- Content
---
# Example slide 2
- More content
[!NOTE] There should be no trailing white space after
---.
Run
slidec example_slides.md
Install
Dev
In chosen python environment, from repo root directory, run
pip install -e .
Navigation
Once in presentation mode
- Next slide:
norj - Previous slide:
pork - Select slide:
gnavigate with fuzzy search (requiresfzf) - quit:
q
Inspiration
There are other much more robust tools for this task, such as
lookatme or
slides.
However, I found I could get all the functionality I needed in a single small python script.
As an exercise, I have since turned the slidec.py script it into a python package for
easy install, though it still works on it's own.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file slidec-0.1.0.tar.gz.
File metadata
- Download URL: slidec-0.1.0.tar.gz
- Upload date:
- Size: 4.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60c33e03615e3afcfb4a42d3000b5b859ae8ec9c72c43f146b9508654777d714
|
|
| MD5 |
6ea0d27161103f0d3361923e8cba9445
|
|
| BLAKE2b-256 |
b1d7707d71167447af2585b3c759ba90c2cb1ccdf71d2714e3ccf0c70f74d37e
|
File details
Details for the file slidec-0.1.0-py3-none-any.whl.
File metadata
- Download URL: slidec-0.1.0-py3-none-any.whl
- Upload date:
- Size: 4.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fe3948802c90f5cbad890af9f07e5fb73b4b2e9f162e5b5b88ef10aca6fa0da6
|
|
| MD5 |
2718453619bf4a2e250ecff646ee3517
|
|
| BLAKE2b-256 |
c8f1190836aa378c1d0abc02af0d42ba93f74e1424e3469da1c0c349deaac183
|