Presently

A web-based presentation tool built with Lively. Write your slides in Markdown, present them in the browser, and control everything from a separate presenter display.

Features

• Markdown slides with YAML frontmatter for metadata and template selection.
• Presenter display with current slide, next slide preview, notes, and timing.
• Real-time sync between display and presenter via WebSockets.
• Code highlighting with @socketry/syntax, including animated focus regions for code walkthroughs.
• Multiple templates — title, section, two-column, code, translation, image, and default.
• Timing and pacing — per-slide duration metadata with elapsed/remaining time and pacing indicators.
• Full-screen support — press F on the display view.
• Keyboard navigation — arrow keys, space, Page Up/Down.

Usage

Please see the project documentation for more details.

• Getting Started - This guide explains how to use presently to create and deliver web-based presentations using Markdown slides.

Releases

There are no documented releases.

See Also

• lively — The real-time application framework that powers Presently.
• falcon — The web server used to host presentations.
• syntax-js — Syntax highlighting for code slides.
• markly — CommonMark parser used for slide content.

Contributing

We welcome contributions to this project.

1. Fork it.
2. Create your feature branch (git checkout -b my-new-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin my-new-feature).
5. Create new Pull Request.

Running Tests

To run the test suite:

bundle exec sus

Making Releases

To make a new release:

bundle exec bake gem:release:patch # or minor or major

Developer Certificate of Origin

In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.

Community Guidelines

This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.