https://github.com/nikku/pfwr

Turns your Markdown file into a beautiful HTML slide deck. Batteries included.
https://github.com/nikku/pfwr

markdown markdown-to-html slide-deck-applications

Last synced: 24 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/nikku/pfwr
• Owner: nikku
• License: mit
• Created: 2021-01-07T23:30:28.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-03-15T11:31:24.000Z (over 1 year ago)
• Last Synced: 2024-10-04T12:51:50.641Z (about 1 month ago)
• Topics: markdown, markdown-to-html, slide-deck-applications
• Language: HTML
• Homepage: https://www.npmjs.com/package/pfwr
• Size: 300 KB
• Stars: 27
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pfwr

[![CI](https://github.com/nikku/pfwr/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/pfwr/actions/workflows/CI.yml)

Turns your [Markdown file](https://github.com/nikku/pfwr/blob/main/README.md#example) into [a beautiful HTML slide deck](https://cdn.statically.io/gh/nikku/pfwr/v0.8.0/example/presentation.html). Batteries included.

## Introduction

[![Slide deck generated from Markdown via pfwr](https://raw.githubusercontent.com/nikku/pfwr/main/docs/screenshot.png)](https://cdn.statically.io/gh/nikku/pfwr/v0.8.0/example/presentation.html)

## Usage

Install the package globally via `npm`:

```sh

npm install -g pfwr

```

Then, transform your Markdown file with the `pfwr` tool:

```sh

pfwr presentation.md presentation.html

```

## Features

* Recognizes [CommonMark](https://commonmark.org/) and [GitHub flavored Markdown](https://github.github.com/gfm/)

* Creates a self-contained, printable HTML slide deck

* Embeds HTML, on purpose (cf. [security considerations](#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:

```markdown

---

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:

```sh

pfwr presentation.md presentation.html

```

Open [the slide deck](https://cdn.statically.io/gh/nikku/pfwr/v0.8.0/example/presentation.html) in your favorite browser.

## Security Considerations

[pfwr](https://github.com/nikku/pfwr) embeds arbitrary HTML contained in your Markdown file. Thus, it is not safe to use on untrusted input.

## License

MIT