https://github.com/websealevel/poc-marp
Poc marp, ecosystème markdown pour produire des slides à partir de fichiers markdown
https://github.com/websealevel/poc-marp
markdown marp marpit marpit-markdown slides
Last synced: 1 day ago
JSON representation
Poc marp, ecosystème markdown pour produire des slides à partir de fichiers markdown
- Host: GitHub
- URL: https://github.com/websealevel/poc-marp
- Owner: websealevel
- Created: 2022-07-20T19:47:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-25T15:59:42.000Z (over 2 years ago)
- Last Synced: 2024-04-08T02:21:54.007Z (over 1 year ago)
- Topics: markdown, marp, marpit, marpit-markdown, slides
- Language: HTML
- Homepage:
- Size: 4.89 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-fr - poc Marp
README
# Marp
- [Marp](#marp)
- [Instalation du programme en ligne de commande (`marp-cli`)](#instalation-du-programme-en-ligne-de-commande-marp-cli)
- [macOS](#macos)
- [Windows](#windows)
- [Debian/Ubuntu](#debianubuntu)
- [Installation via les binaires](#installation-via-les-binaires)
- [Installation via `node` et `npm`](#installation-via-node-et-npm)
- [Afficher la liste des options](#afficher-la-liste-des-options)
- [Watch (*hot reload*)](#watch-hot-reload)
- [Conversions](#conversions)
- [Au format PDF](#au-format-pdf)
- [Au format HTML](#au-format-html)
- [Au format PPTX (powerpoint) **lecture seule**](#au-format-pptx-powerpoint-lecture-seule)
- [Au format PPTX (powerpoint) **éditable**](#au-format-pptx-powerpoint-éditable)
- [Conversion avec inclusion de fichiers multimédias](#conversion-avec-inclusion-de-fichiers-multimédias)
- [Vers d'autres formats (XML, LaTeX, etc.)](#vers-dautres-formats-xml-latex-etc)
- [Création d'un thème](#création-dun-thème)
- [Workflow](#workflow)
- [Autoriser le markup HTML dans les slides](#autoriser-le-markup-html-dans-les-slides)
- [Points à eclaircir](#points-à-eclaircir)
- [Ressources](#ressources)
## 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](https://github.com/marp-team/marp-cli).
### macOS
Installer marp via le gestionnaire de paquets [Homebrew](https://brew.sh/index_fr)
~~~bash
brew install marp-cli
~~~
### Windows
Installer marp via le gestionnaire de paquets [Scoop](https://scoop.sh/)
~~~bash
scoop install marp
~~~
### Debian/Ubuntu
#### Installation via les binaires
Télécharger l'archive contenant les binaires [depuis son dépôt GitHub](https://github.com/marp-team/marp-cli/releases).
Extraire l'archive
~~~bash
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
~~~bash
sudo cp marp /usr/local/bin
~~~
Vérifier que marp est bien installé
~~~bash
marp -h
~~~
#### Installation via `node` et `npm`
Installer [node](https://packages.debian.org/fr/sid/nodejs) et [npm](le gestionnaire de paquets de node), puis installer `marp-cli` globalement (option `-g`)
~~~bash
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
~~~bash
marp -h
~~~
Il est possible de mettre toutes les options dans un fichier de configuration `marp.conf`, puis de le charger
~~~bash
marp -c marp.conf slide-deck.md
~~~
## Watch (*hot reload*)
On peut également observer notre fichier de présentation markdown avec l'option `-w`
~~~bash
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
~~~bash
marp --pdf slide-deck.md
~~~
### Au format HTML
~~~bash
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**
~~~bash
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](#au-format-pdf) puis utiliser un outil comme [PDF to Powerpoint Converter](https://pdf.online/pdf-to-powerpoint-converter) ou [Adobe](https://www.adobe.com/acrobat/online/pdf-to-ppt.html)
## 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,
~~~bash
marp --theme my-theme.css --pdf --allow-local-files slide-deck.md
~~~
ou
~~~bash
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](#au-format-html) puis utiliser [pandoc](https://pandoc.org/index.html)
## 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`
~~~bash
marp --theme my-theme.css slide-deck.md
~~~
## Workflow
Watch les sources markdown avec un thème custom
~~~bash
marp --theme my-theme.css -w slide-deck.md
~~~
Exporter vers des images dans un fichier powerpoint
~~~bash
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`
~~~bash
marp --html --theme my-theme.css -w slide-deck.md
~~~
## Points à eclaircir
- La directive `_class`
- import video et images
## Ressources
- [Marp écosystème](https://marp.app/)
- [Marpit framework](https://marpit.marp.app/), sur quoi est basé marp
- [Marpit API](https://marpit-api.marp.app/index.html)
- [Doc officielle Marp CLI](https://github.com/marp-team/marp-cli)
- [Produire un powerpoint editable dans le workflow de Marp](https://github.com/marp-team/marp/discussions/82), l'export vers pptx de marp ne cree pas une présentation éditable mais une version images. Pour produire un ppt éditable il faut passer par le format pdf avant
- [Pandoc](https://pandoc.org/index.html), un convertisseur de document universel et éprouvé
- [Convertisseur pdf vers powerpoint](https://pdf.online/pdf-to-powerpoint-converter), un outil de conversion en ligne gratuit permettant de convertir un fichier PDF vers un fichier pptx éditable