Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.
/ remarker Public archive

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

License

Notifications You must be signed in to change notification settings

tylerdave/remarker

Repository files navigation

Remarker

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.

Status

Note

This project is no longer maintained. Check out @eswan18's fork with additional features premark

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

About

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

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published