https://github.com/janinawibker/marp-theme
minimal marp theme
https://github.com/janinawibker/marp-theme
github-actions markdown marp minimal presentation template
Last synced: 3 months ago
JSON representation
minimal marp theme
- Host: GitHub
- URL: https://github.com/janinawibker/marp-theme
- Owner: JaninaWibker
- License: mit
- Created: 2023-03-23T14:53:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-06T10:02:48.000Z (about 1 year ago)
- Last Synced: 2025-01-25T20:43:33.584Z (5 months ago)
- Topics: github-actions, markdown, marp, minimal, presentation, template
- Language: CSS
- Homepage:
- Size: 494 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Marp theme
This is a **minimal marp theme** as well as "boilerplate project" for marp presentations.
It contains the theme in `theme/` and a few basic markdown-it plugins (see `engine/engine.js`).
See the [marp website](https://marp.app/) for a ton more information, especially this [reference](https://marpit.marp.app/) for the available features and syntax is useful.
[pnpm](https://pnpm.io) was chosen as the package manager, but npm works as a drop-in replacement.
The primary workflow is cloning this repository and using it as a base for your own repo.
```sh
git clone https://github.com/JaninaWibker/marp-theme
git remote remove origin
git remote add origin
pnpm install
pnpm dev # for browser preview
pnpm build # for building slides (pdf)
```
## Overview
Check out the generated PDF in the Releases tab.
## Structure
```sh
.
├── engine/
│ └── engine.js # add markdown-it plugins in here
├── output/ # pdf output goes here
├── package.json
├── slides/ # put your slides in here
└── theme/ # all theme related things come in here
├── code.css # code block related
├── colors.css # css variables (default and .invert)
├── headings.css # all things headings
└── minimal.css # entry point and general styles
```
## Automation
Included in this repo is a github action for automatically building your slides and creating a release whenever you push a tag (starting with `v` for version).
To use this update the `OUTPUT_FILE_NAME` at the top of `.github/workflows/build.yml` to fit your filename.
## License
This project is licensed under MIT (see `LICENSE` file).
Just add yourself to the `LICENSE` file and thats it.
If you want to outright remove the license file you can do so but maybe drop a link somewhere to this repo (along with the info that it's MIT licensed), that would be neat :3
## Attribution
This repo uses the [Rosé Pine](https://rosepinetheme.com/) theme (base and dawn variants) for code blocks.