Skip to content

NYPL/nypl-marp-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

New York Public Library's Marp Template

Use Marp to create NYPL themed slide decks from markdown files (Sample PDF output).

usage

Note

This is an early version of the template and has not been audited by the communications team. We recommend using it for internal presentations only. Please reach out to the communications team if you intend to use this template for public-facing presentations.

Usage

There are two ways to use this template: CLI and VS Code extension.

CLI

$ git clone https://github.com/NYPL/nypl-marp-template.git
$ cd nypl-marp-template

With npx command, run:

$ npx @marp-team/marp-cli sample.md --theme-set ./themes/nypl-marp-template.scss --pdf
$ npx @marp-team/marp-cli sample.md --theme-set ./themes/nypl-marp-template.scss --pdf -w # watch mode for live preview

VS Code

  • Install extention: Marp for VS Code
  • Go to settings and search for markdown.marp.themes
  • Add the following url
https://raw.githubusercontent.com/NYPL/nypl-marp-template/refs/heads/main/themes/nypl-marp-template.scss
  • Open your markdown file in VS Code.
  • Use the VS Code command palette (Ctrl+Shift+P or Cmd+Shift+P) and search for "Marp: Export Slide Deck" to export your slides as PDF or PowerPoint.

Contributing

PRs are widely welcome especially for improving themes.

About

Marp template themed with NYPL design guidelines.

Resources

Stars

Watchers

Forks

Contributors

Languages