marp	true
theme	default
title	README
header	README
paginate	true

presentation-template

by @plageoj

A template GitHub repository to create and organize your presentation with Marp

View demo slide for README.md

---

How to use

1. Fork this repository
2. Enable GitHub Pages according to the next section
3. Clone the repository or open web editor
4. Write your markdown presentation
5. Commit and push
6. You should see slide list at https://your-name.github.io/repo-name/

---

Enabling GitHub Pages

Enable GitHub Pages on repository pages settings and choose GitHub Actions as source.

This enables presentation slide listing. After you push the markdown file to remote repository, the listing will be automatically updated and released.

---

Writing slide

In the top section of the markdown, you have to include at least these two lines to enable presentation features and list the slide on the index page:

---
marp: true
title: Your presentation title here

---

# content here

If title is missing the file will be hidden but accessible by typing filename directly.

For other options and full features visit marp.app and its Markdown documentation.

---

Contribution

1. Fork this repository
2. Make your own improvements
3. Send a pull request
   • Make sure you don't include slide contents in PR

Feel free to open / discuss on issues.