Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A terminal-based presentation tool with colors and effects.

Project description

present

Documentation Status image image image

A terminal-based presentation tool with colors and effects.

present is built on asciimatics.

Installation

You can simply use pip to install present:

$ pip install present

Usage

$ present sample.md

You can navigate between slides using the arrow keys and quit the presentation with q. At the end, you can use r to restart the presentation.

Syntax

Slides follow Markdown syntax. You can check out the sample slides for reference.

Note: Some things aren't supported yet.

  • Emphasis, inline code, links, blockquotes, tables and strikethroughs.
  • Effects and foreground / background colors on the same slide.
  • Effects and code on the same slide.

Separator

Each slide can be separated with a ---.

Slide 1

---

Slide 2

Text

Slide 1

---

Slide 2

Headers

Level 1 headings become figlets, level 2 headings get underlined with -, and level 3 headings are treated as normal text, for now.

# Heading 1

## Heading 2

### Heading 3

Lists

Ordered lists become unordered lists automatically, for now.

- Item 1
    - Item 1a
    - Item 1b
    - Item 1c
- Item 2
    - Item 2a

Images

Image paths are relative to the directory where your slides are kept, and where you invoke present.

![RC](images/recurse.png)

Code blocks

```
import os

os.getcwd()
```

Style

Each slide can be styled with foreground / background colors and effects. By default, slides are black on white with no effects. You can add style to a slide by adding a comment at the beginning of the slide (after the slide separator):

Slide 1

---
<!-- fg=black bg=yellow -->

Slide 2

---
<!-- effect=explosions -->

Slide 3

Color options: black, red, green, yellow, blue, magenta, cyan, white.

Effect options: explosions, stars, matrix, plasma. More coming soon!

Versioning

present uses Semantic Versioning. For the available versions, see the tags on the GitHub repository.

License

This project is licensed under the Apache License, see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for present, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size present-0.4.0-py3-none-any.whl (32.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size present-0.4.0.tar.gz (22.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page