Skip to main content

Command line tool to generate Remark.js presentations from markdown files

Project description

Premark

CI Status Docs Status

Premark generates single-file HTML presentations from one or many markdown files, using Remark.js. Based on Remarker by @tylerdave.

License: MIT

Documentation: Read The Docs

Notable Features

  • Create slides from simple Markdown. Use three dashes on their own line (---) to indicate the transition from one slide to another. All other markdown features work as expected.

  • The output is always a single HTML file. This means you can open it in your browser without spinning up a web server.

    • In contrast, with vanilla Remark, if your main HTML file needs to load any other files then it can't be opened locally without a web server.
  • Your slides can be stored in multiple markdown files and Premark will automatically "stitch" them together into a single presentation, even creating title slides for each section if you want.

Usage Example

Generate presentation.html from Markdown in slides.md:

premark -o presentation.html slides.md

Project details


Download files

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

Source Distribution

Premark-0.0.9rc0.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

Premark-0.0.9rc0-py2.py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page