Skip to content

Poc marp, ecosystème markdown pour produire des slides à partir de fichiers markdown

Notifications You must be signed in to change notification settings

websealevel/poc-marp

Repository files navigation

Marp

Instalation du programme en ligne de commande (marp-cli)

Toutes les possibilités d'installation de l'application sont listées sur le dépôt.

macOS

Installer marp via le gestionnaire de paquets Homebrew

brew install marp-cli

Windows

Installer marp via le gestionnaire de paquets Scoop

scoop install marp

Debian/Ubuntu

Installation via les binaires

Télécharger l'archive contenant les binaires depuis son dépôt GitHub.

Extraire l'archive

tar xvzf marp-cli-v{derniere version}-linux-tar.gz

Copiez l'éxecutable présent dans l'archive dans un répertoire présent sur le PATH, par exemple

sudo cp marp /usr/local/bin

Vérifier que marp est bien installé

marp -h

Installation via node et npm

Installer node et [npm](le gestionnaire de paquets de node), puis installer marp-cli globalement (option -g)

sudo apt-get update
sudo apt-get install nodejs npm
npm install -g @marp-team/marp-cli

Afficher la liste des options

Consulter la liste des options offertes par marp

marp -h

Il est possible de mettre toutes les options dans un fichier de configuration marp.conf, puis de le charger

marp -c marp.conf slide-deck.md

Watch (hot reload)

On peut également observer notre fichier de présentation markdown avec l'option -w

marp -w slide-deck.md

Marp convertira uniquement le fichier indiqué lorsqu'il observera des modifications (ici en HTML par défaut). On peut donc ouvrir la présentation HTML générée dans notre navigateur pour avoir une preview optimisée avec un hot reload.

Conversions

Au format PDF

Utilise Chrome ou Chromium

marp --pdf slide-deck.md

Au format HTML

marp slide-deck.md

Au format PPTX (powerpoint) lecture seule

La conversion opère juste une conversion en images au format .pptx. Le document peut être ouvert dans powerpoint mais non éditable

marp --pptx slide-deck.md

Au format PPTX (powerpoint) éditable

Pour convertir la présentation markdown en pptx éditable, on peut passer par le format PDF puis utiliser un outil comme PDF to Powerpoint Converter ou Adobe

Conversion avec inclusion de fichiers multimédias

Il faut forcer le html avec l'option --html. Pour des exports PDF ou pptx, il faut également autoriser les fichiers locaux avec l'option --allow-local-files. Par exemple,

marp --theme my-theme.css --pdf --allow-local-files slide-deck.md

ou

marp --theme my-theme.css --pptx --allow-local-files slide-deck.md

On ne peut pas inclure de vidéos dans un fichier PDF et donc dans un fichier pptx avec cette méthode. Il vaut mieux uploader la vidéo sur une plateforme, par exemple Youtube et mettre un lien vers la vidéo.

Vers d'autres formats (XML, LaTeX, etc.)

Pour cela on peut passer par la conversion HTML puis utiliser pandoc

Création d'un thème

On peut créer un thème dédié au projet directement en CSS my-theme.css et l'utiliser avec l'option -theme

marp --theme my-theme.css slide-deck.md

Workflow

Watch les sources markdown avec un thème custom

marp --theme my-theme.css -w slide-deck.md

Exporter vers des images dans un fichier powerpoint

marp --theme my-theme.css --pptx slide-deck.md

Les notes seront affichées pour la personne qui fait la présentation.

Autoriser le markup HTML dans les slides

Utiliser l'option --html

marp --html --theme my-theme.css -w slide-deck.md

Points à eclaircir

  • La directive _class
  • import video et images

Ressources

About

Poc marp, ecosystème markdown pour produire des slides à partir de fichiers markdown

Topics

Resources

Stars

Watchers

Forks