timsueberkrueb / marp-cli-example

The good starter for using Marp via Marp CLI

Marp CLI example

The good starter example for using Marp via Marp CLI.

• Write your slide deck by Marp Markdown.
• Manage the content of slides via Git. (Using GitPitch style PITCHME.md)
• Host your deck at GitHub, and publish as webpage with GitHub Pages, Netlify, and ZEIT Now!

See published slide deck

• GitHub Pages: https://yhatt.github.io/marp-cli-example
• Netlify: https://yhatt-marp-cli-example.netlify.com/
• ZEIT Now: https://marp-cli-example.yhatt.now.sh/

Usage

It's surprisingly easy to start publishing your slide deck!

GitHub Pages

Fork this repository from "Fork" button in right-top corner to start!

Setup GitHub Actions

We have GitHub Actions workflow to build and deploy from master to gh-pages automatically.

In the moment, deploying from public repository to GitHub Pages requires setting up your access token as secret. (Track discussion in forum...)

1. Go to "Personal Access Tokens" setting page and click "Generate New Token".
2. Create new token with "repo" scope, and copy generated token.
3. Go to "Settings" tab in forked repository, and select "Secrets" from sidebar.
4. Add a new secret "ACCESS_TOKEN" with the value of generated token.
5. Turn on GitHub Actions in forked repository from "Actions" tab.

Marp slide deck generated from PITCHME.md will be published to https://<your-name>.github.io/<repository-name>.

⚠️ Please notice the slide deck hosted with GitHub Pages will be made public even if you forked this to private repository.

Netlify

Push "Deploy to netlify" button. Netlify will create your repository based on this example and host website from master branch automatically.

ZEIT Now

Push "Deploy" button. ZEIT Now can choose to create your repository into GitHub / GitLab based on this example, or just to try publishing slide deck in your without fork.

ℹ️ The auto-generated open graph image is not available in deployment through ZEIT Now.

How to write

For Marp slide deck features, please see the documentation of Marpit Markdown, the features of Marp Core, and the default example in PITCHME.md for .

You have to install Node.js and run npm i at first if you want to write slide deck with Marp CLI.

Edit deck

Just edit PITCHME.md!

Preview deck

Marp for VS Code extension is the best partner for writing Marp slide deck with live preview.

Preview via CLI

npm run start

It will be opened preview window via installed Google Chrome, and track change of PITCHME.md.

Assets and themes

• assets directory can put your assets for using in the deck. (e.g. Image resources)
• themes directory can put custom theme CSS. To use in the deck, please change theme global directive.

Build deck via CLI

npm run build

The built assets will output to dist folder.

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

LICENSE

WTFPL