Skip to content
/ pfwr Public

Turns your Markdown file into a beautiful HTML slide deck. Batteries included.

License

Notifications You must be signed in to change notification settings

nikku/pfwr

Repository files navigation

pfwr

CI

Turns your Markdown file into a beautiful HTML slide deck. Batteries included.

Introduction

Slide deck generated from Markdown via pfwr

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

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

About

Turns your Markdown file into a beautiful HTML slide deck. Batteries included.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project