Skip to content

aquastripe/marp-pages

Repository files navigation

Marp Pages

Marp Pages is a static site generator with Marp. You can:

  • Make slides using Markdown syntax.
  • Publish slide decks on GitHub Pages automatically with GitHub Actions.

Example: https://aquastripe.github.io/marp-pages/example/

Usage

Prerequisite

  • Node.js
  • Install dependency packages:
    npm i
  • Python 3.6+

Make slide decks and put them in the content/ directory. This work is based on Marp, your slides should follow its settings and dialects.

Preview

npm run preview

Publish on GitHub Pages

  1. Commit and push to your GitHub repository.
  2. Setup GitHub Pages and change the branch to gh-pages:
    1. Navigate to Settings/Pages
    2. Select Branch to gh-pages and save.

About

A static site generator with Marp

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published