Skip to main content

A command line tool to generate Remark.js presentations from markdown files.

Project description

https://img.shields.io/travis/tylerdave/remarker.svg https://img.shields.io/pypi/v/remarker.svg https://coveralls.io/repos/github/tylerdave/remarker/badge.svg?branch=master

A command line tool for generating Remark.js presentations from markdown files.

License: MIT

Documentation: https://remarker.readthedocs.org.

Usage

remarker --help

Usage: remarker [OPTIONS] SLIDES_MARKDOWN_FILE

  Generate a Remark.js HTML presentation from input Markdown and optional
  custom CSS.

Options:
  --version                   Show the version and exit.
  -v, --verbose               Output debugging info.
  -t, --title TEXT            HTML title of the presentation.
  -o, --output-file FILENAME  Write the output to a file instead of STDOUT.
  -c, --css-file PATH         Custom CSS to be included inline.
  --html-template PATH        Jinja2 template file for the presentation.
  --help                      Show this message and exit.

Usage Examples

Generate presentation.html from Markdown in slides.md:

remarker -o presentation.html slides.md

Generate presentation.html from Markdown in slides.md and CSS in style.css:

remarker -o presentation.html -c style.css slides.md

History

Pre-release

Supported by

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