Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://rnd195.github.io/marp-community-themes/

Theme gallery for Marp maintained by the community
https://rnd195.github.io/marp-community-themes/

marp marp-themes

Last synced: about 2 months ago
JSON representation

Theme gallery for Marp maintained by the community

Awesome Lists containing this project

README

        

# Marp Community Themes

This is a community-maintained theme gallery for [Marp](https://marp.app/). For more information about how to create themes for Marp, see the official [documentation](https://marpit.marp.app/theme-css).

The website is built using [Quarto](https://quarto.org/) and it is inspired by the Typora [theme gallery](https://theme.typora.io/).

Feel free to provide any suggestions in the issues tab. Please note that this theme gallery is an independent, community-maintained project and is not affiliated with the official Marp project.

# Installation / Usage

After clicking the "Download CSS" button on any theme's page, your browser likely loads the `.css` file instead of downloading it. You can save the `.css` file locally using `Ctrl + S`.

### Marp for VS Code Extension

1. Open Settings in VSCode (`Ctrl + ,`)
2. Search for `markdown.marp.themes`
3. Add a URL or a local path to the `.css` file
- URL: refer to [this discussion](https://stackoverflow.com/questions/17341122/link-and-execute-external-javascript-file-hosted-on-github/) about linking to files on GitHub
- Local path example: `./assets/theme_name.css` (theme needs to be somewhere in the project's directory)

4. Enable the theme in the front-matter of the Markdown document, i.e., write the following at the very beginning of the Markdown document:

```
---
marp: true
theme: theme_name
---
```

For additional settings (such as `size` or `paginate`), follow the [official documentation](https://github.com/marp-team/marp/blob/main/website/docs/guide/directives.md).

### Marp CLI

1. Put the `.css` theme file in the directory of your Markdown document
2. Use the `--theme` parameter during the export and specify the path to the `.css` file
- e.g.:

```
marp --theme ./assets/theme_name.css document.md -o document.pdf
```

# Submitting themes

Work in progress. Not accepting submissions at the moment, sorry.

# License

This software is licensed under the [MIT License](https://github.com/rnd195/marp-community-themes/blob/live/LICENSE). License files of the featured themes can be found in the `themes/licenses/` directory.

# Privacy notice

Please, be aware that some of the featured themes import fonts from the Google Fonts service. Refer to their [Privacy FAQ](https://developers.google.com/fonts/faq/privacy) for more information.