Skip to content

yash-srivastava19/py_slides

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

py_slides

A terminal-based markdown slide presentation tool inspired by the Go package "slides".

screengrab of py_slides

Installation(SOON)

Till I pulish the package on PyPI, consider cloning the repository and using py_slides.

pip install py_slides

Usage

py_slides path/to/your_presentation.md

Markdown Format

Slides are separated by horizontal rules (---). Speaker notes are indicated with the ?> prefix.

Example:

# Slide Title

Content for the first slide.

?> Speaker notes for this slide.

---

# Second Slide

* Bullet point 1
* Bullet point 2

```python
def code_example():
    return "Code blocks are supported"

?> More speaker notes here.


## Key Controls

* `n`, `Right Arrow`, `Space` - Next slide
* `p`, `Left Arrow` - Previous slide
* `f` - First slide
* `l` - Last slide
* `s` - Toggle speaker notes
* `h` - Help screen
* `q` - Quit

## Requirements

* Python 3.11+
* Dependencies: blessed, rich

## License
MIT

About

A terminal based application that converts markdown into slides that just works so you don't bang your head on the wall

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages