pfwr
v0.8.0
Published
The last markdown to HTML slide show generator you need
Downloads
27
Maintainers
Readme
pfwr
Turns your Markdown file into a beautiful HTML slide deck. Batteries included.
Introduction
Usage
Install the package globally via npm
:
npm install -g pfwr
Then, transform your Markdown file with the pfwr
tool:
pfwr presentation.md presentation.html
Features
- Recognizes CommonMark and GitHub flavored Markdown
- Creates a self-contained, printable HTML slide deck
- Embeds HTML, on purpose (cf. security considerations)
- Allows you to configure meta-data via front-matter
- Watch mode (rebuild on changes)
Example
Write your presentation in a single Markdown file:
---
title: What is pfwr
author: nikku
---
# *pfwr*
### What the heck is this
---
### *Disclaimer* I built this tool :wink:
Normal text may be added.
---
* bullet points
* are supported, too
---
![](./assets/me.jpg)
---
:arrow_right: [Checkout on GitHub](https://github.com/nikku/pfwr)
Convert the file to an HTML file:
pfwr presentation.md presentation.html
Open the slide deck in your favorite browser.
Security Considerations
pfwr embeds arbitrary HTML contained in your Markdown file. Thus, it is not safe to use on untrusted input.
License
MIT