This is a template repository for creating slides with Marp.
- Click the "Use this template" button to create a new repository.
- Enable GitHub Actions to build and deploy your slide:
- Navigate to
https://github.com/{username}/{repository-name}/settings/pagesand selectGitHub Actionsas the source.
- Navigate to
- Write your slide content in the
slidesdirectory:- To split your slide into multiple files, create
{number}_{title}.mdfiles in theslidesdirectory. - Files are sorted numerically by number and then concatenated. See the "Warning" section for details.
- Files under the
slidesdirectory will be copied to thebuilddirectory. Therefore, please place images and other assets here.
- To split your slide into multiple files, create
- Push changes to the
mainbranch. - Your slide will be published at
https://<username>.github.io/<repository-name>🤗
This template uses the honwaka-theme as the default theme. You can customize the theme by editing the Makefile and .marprc.yml files.
- Edit
Makefile:- Modify
THEME_NAMEandTHEME_REPOto your theme. (THEME_REPO = https://github.com/{username}/{theme-repository}. andTHEME_NAME = {theme-repository})
- Modify
- Edit
.marprc.yml:- Change the
themefield to your desired theme.
- Change the
- Run
make allto build the slide in thebuild/directory:- This command generates
.html,.pdf, and.pptxfiles. Individual targets likemake html,make pdf, andmake pptxare also available.
- This command generates
make previewto start a local server with auto-reload:- Opens your slide in a browser for preview.
- Automatically watches the
slides/directory for changes and rebuilds the slide when files are modified.
When splitting slides into multiple files, follow these rules:
- Files are sorted before concatenation based on their names, so using
{number}_{title}.mdis recommended. - YAML front matter is only applied from the first file:
- The first file retains its YAML front matter. Subsequent files are concatenated without YAML front matter.