{"id":15654462,"url":"https://github.com/nikku/pfwr","last_synced_at":"2025-04-30T23:48:09.597Z","repository":{"id":45729987,"uuid":"327748726","full_name":"nikku/pfwr","owner":"nikku","description":"Turns your Markdown file into a beautiful HTML slide deck. Batteries included.","archived":false,"fork":false,"pushed_at":"2025-04-30T10:38:23.000Z","size":445,"stargazers_count":30,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-30T23:48:02.846Z","etag":null,"topics":["markdown","markdown-to-html","slide-deck-applications"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/pfwr","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nikku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["nikku"]}},"created_at":"2021-01-07T23:30:28.000Z","updated_at":"2025-04-30T10:38:27.000Z","dependencies_parsed_at":"2024-10-23T04:19:06.365Z","dependency_job_id":null,"html_url":"https://github.com/nikku/pfwr","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fpfwr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fpfwr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fpfwr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikku%2Fpfwr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikku","download_url":"https://codeload.github.com/nikku/pfwr/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251801086,"owners_count":21645968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-to-html","slide-deck-applications"],"created_at":"2024-10-03T12:51:54.196Z","updated_at":"2025-04-30T23:48:09.591Z","avatar_url":"https://github.com/nikku.png","language":"HTML","funding_links":["https://github.com/sponsors/nikku"],"categories":[],"sub_categories":[],"readme":"# pfwr\n\n[![CI](https://github.com/nikku/pfwr/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/pfwr/actions/workflows/CI.yml)\n\nTurns 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.9.1/example/presentation.html). Batteries included.\n\n\n## Introduction\n\n[![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.9.1/example/presentation.html)\n\n\n## Usage\n\nInstall the package globally via `npm`:\n\n```sh\nnpm install -g pfwr\n```\n\nThen, transform your Markdown file with the `pfwr` tool:\n\n```sh\npfwr presentation.md presentation.html\n```\n\n\n## Features\n\n* Recognizes [CommonMark](https://commonmark.org/) and [GitHub flavored Markdown](https://github.github.com/gfm/)\n* Creates a self-contained, printable HTML slide deck\n* Embeds HTML, on purpose (cf. [security considerations](#security-considerations))\n* Allows you to configure meta-data via front-matter\n* Watch mode (rebuild on changes)\n\n\n## Example\n\nWrite your presentation in a single Markdown file:\n\n```markdown\n---\ntitle: What is pfwr\nauthor: nikku\n---\n\n# *pfwr*\n\n### What the heck is this\n\n---\n\n### *Disclaimer* I built this tool :wink:\n\nNormal text may be added.\n\n---\n\n* bullet points\n* are supported, too\n\n---\n\n![](./assets/me.jpg)\n\n---\n\n:arrow_right: [Checkout on GitHub](https://github.com/nikku/pfwr)\n```\n\nConvert the file to an HTML file:\n\n```sh\npfwr presentation.md presentation.html\n```\n\nOpen [the slide deck](https://cdn.statically.io/gh/nikku/pfwr/v0.9.1/example/presentation.html) in your favorite browser.\n\n\n## Security Considerations\n\n[pfwr](https://github.com/nikku/pfwr) embeds arbitrary HTML contained in your Markdown file. Thus, it is not safe to use on untrusted input.\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Fpfwr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikku%2Fpfwr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikku%2Fpfwr/lists"}