Presentations to Webpages: Instantly!
Marp lets you create HTML slides from markdown (like this!).
This presentation is both a website and a README.md.
Treat your presentation the same way you treat code.
Want to create your own?
First, create a new repo from the template repo.
Open your new repo and setup publishing.
You'll typically use gh-pages as the deploy branch.
Click on Actions tab and see if the build succeeded (it may take some time).
You should now see the generated files in the gh-pages branch.
Open your deployed webpage to see the content.
Out of the box you should see README.md as /index.html and /README.pdf. Slides under docs/ are also converted.
Locally you'll run commands like:
$ marp README.md -o build/README.pdf
$ npx @marp-team/marp-cli@latest README.md -o build/README.pdf
The workflow runs an equivalent step:
- name: Marp Build (README.pdf)
args: README.md -o build/README.pdf
Note the args match the previous slide.
Anything in the build/ folder will be deployed to GitHub Pages.
You can copy extra files or run further processing steps using other tools.
This is a good time to learn more about Marp. Here's some resources:
Known sites using this action are:
Send a pull request to get your site added.
When you are ready to share your presentation, commit or merge to main and your content on GitHub Pages will automatically update.