Marp Action for GitHub
Presentations to Webpages: Instantly!
What?
Marp lets you create slides from markdown (like this!).
Marp Action lets you automatically deploy your presentation to GitHub Pages.
This presentation is both a website and a README.md.
Why?
Treat your presentation the same way you treat code.
Use git to track changes. Pull requests to collaborate. Deploy to a webpage automatically.
See a bug? Open an issue or pull request!
Setup
Want to create your own?
First, create a new repo from the template repo.
Configure GitHub Pages
Remember the branch and URL shown.
Update Workflow
You'll update the workflow file over the next few slides. You can do this right in the GitHub web page (click on the pencil icon).
.github/workflows/main.yml
BASE_URL
Set this to the domain you're using for GitHub Page (from earlier).
If you add a custom domain later, you'll need to update this.
PUBLISH_TO_BRANCH
Tell the build which branch you are using for GitHub Pages (you picked this earlier).
This is likely either master or gh-pages. Set PUBLISH_TO_BRANCH to the correct branch.
Update Workflow
Commit .github/workflows/main.yml back to dev branch.
This will kick off a build.
Check if the build succeeded
Click on Actions tab and see if the build succeeded.
Load your new web page
Any update to your site will take a few minutes to be visible. Be patient.
Create your slides
Finally, start adding your own content.
You can install and run marp-cli locally to test out the content before publishing.
Learn more about Marp
This is a good time to learn more about Marp. Here's some resources:
Publish your slides
When you are ready to share your presentation, commit or merge to dev and your content on GitHub Pages will automatically update.