Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.73 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.73 KB
Raw

Marp Slides Template

Use this template!

Create a Marp presentation site that can be built and published on [GitHub Pages] using this minimal template. The site features:

  • Marp integration
  • A GitHub Pages / Actions workflow for build and publish (See a preview)
  • A DevContainer/CodeSpace configuration with Marp and Markdown preview extensions
  • Chrome installation for PDF and PowerPoint slide creation on Linux

Customization

Feel free to customize the sites created with this template as you like!

Getting Started

  1. Click "[use this template]" to create a new site.
  2. Update the content of slides/Slides.md with your own presentation.

Custom Themes

This template includes four custom themes in the slides/themes folder:

  • custom
  • custom-default (based on the built-in default theme)
  • custom-gaia (based on the built-in gaia theme)
  • custom-uncover (based on the built-in uncover theme)

To use a custom theme, edit the relevant css file and add its reference in the front matter of Slides.md. For example, to use custom-default add the following to the Slides.md front matter:

---
marp: true
theme: custom-default
---

For additional themes, add them to the devcontainer and follow the Marp custom theme documentation.

Publishing on GitHub Pages

  1. In your GitHub repo, navigate to Settings > Pages > Build and deployment.
  2. Select Source: GitHub Actions.
  3. If any Actions failed, go to the Actions tab and click on Re-run jobs.

Local Build and Preview

  1. Install Visual Studio Code.
  2. Install the Marp for VS Code extension.
  3. Open slides/Slides.md in VS Code.

Licensing and Attribution

This repository is licensed under the [MIT License]. Reuse or extend the code as you wish, but include the original license. The deployment GitHub Actions workflow is based on GitHub's starter workflows.

Resources