Marp CLI example
- Write your slide deck by Marp Markdown.
- Manage the content of slides via Git. (Using GitPitch style
- Host your deck at GitHub, and publish as webpage with Netlify / Now!
See published slide
It's surprisingly easy to start writing your slide deck!
Push "Deploy to netlify" button. Netlify will create your repository based on this example and host website automatically.
After than, clone your repository and install Marp CLI. (Required Node.js >= 8)
git clone https://github.com/[your-name]/[repository-name].git cd ./[repository-name] npm install
OK, ready to write your slide deck! Edit
PITCHME.md with your favorite editor, and preview with
npm run start. By pushing Git commit to
master, Netlify will host the deck to website.
ℹ️Netlify integration can make an Open Graph image automatically.
git clone https://github.com/yhatt/marp-cli-example.git cd ./marp-cli-example now
An example slide will publish to
https://marp-cli-example.[your-name].now.sh. When you made a satisfied deck by editing
PITCHME.md, publish to your favorite and friendly URL by
# Alias to https://friendly-subdomain.now.sh now alias https://marp-cli-example.[your-name].now.sh friendly-subdomain # Alias to your custom domain registered to Now now alias https://marp-cli-example.[your-name].now.sh your-custom-domain.com
Of course, you can manage deck via Git / GitHub at a forked repository. As same as Netlify, Now GitHub integration allows publishing
master branch automatically.
How to write
Marp for VS Code extension is the best partner for writing Marp slide deck with live preview.
Assets and themes
assetsdirectory can put your assets for using in the deck. (e.g. Image resources)
themesdirectory can put custom theme CSS. To use in the deck, please change
npm run start
It will be opened preview window via Chrome, and track change of
npm run build
The built assets will output to
Build per assets
npm run deck # Output static HTML to dist/index.html npm run og-image # Output image for Open Graph to dist/og-image.jpg