Skip to content

hahnec/marp-recipes

Repository files navigation

marp-recipes

This repo features Markdown presentation slide snippets using the Marp framework. Below examples and instructions help setting up the environment.

Results

Getting started

  1. download and install VS Code
  2. open VS Code and choose Extensions on the vertical tab bar
  3. type Marp for VS Code and install the extension
  4. open a Markdown file (e.g. marp_recipes.md from this repo)
  5. press ctrl+shift+v (Linux & Win) or cmd+shift+v on macOS for the slides preview
  6. Unix systems may require an installation of Google Chrome or Chromium

CLI Slide Export

  1. install node.js from https://nodejs.org/en/download/ and make sure it was successful
$ node --version
  1. install marp-cli
$ npm install --save-dev @marp-team/marp-cli
  1. convert file
$ npx @marp-team/marp-cli ./template_hahnec.md --html --pdf --allow-local-files --theme-set ./themes/
$ npx @marp-team/marp-cli ./template_hahnec.md --html --theme ./themes/hahnec.css
$ npx @marp-team/marp-cli ./template_hahnec.md --pptx --theme-set ./themes/

or use the provided bash script to generate outputs

$ bash compile.sh