Skip to content

m1rm/marp-skeleton

Repository files navigation

Presentations

This repo holds a simple setup to create presentations using Marp.

Prerequisites

  • pnpm
  • just
  • git
  • fish
  • xdg-open
  • findutils
  • oxipng
  • jpegoptim

How it works

In the src folder you need to have subfolders. Each subfolder holds one index.md. The subfolder's name corresponds to the name of the generated PDF. Each generated PDF can be found in the dist folder.

Setup

  1. cd src

  2. Install dependencies: just install

  3. cd example

  4. Build the empty example.pdf: just build

  5. Use just watch during your work to enable automatic pdf generation when applying changes

Assets

Assets are placed in the subfolders next to the index.md. pngs and jpegs can be optimized using just optimize.

Custom Styling

Place a theme.css next to the index.md and write your custom css. See https://marpit.marp.app/directives for detailed examples.

Special Thanks

Pierre Schmitz

About

Marp Presentations

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published