samuele-cozzi/obsidian-marp-slides

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Marp Slides for Obsidian

[![Version](https://img.shields.io/github/manifest-json/v/samuele-cozzi/obsidian-marp-slides?color=blue)](https://github.com/samuele-cozzi/obsidian-marp-slides/releases/latest)![Downloads](https://img.shields.io/github/downloads/samuele-cozzi/obsidian-marp-slides/total)[![CodeFactor](https://www.codefactor.io/repository/github/samuele-cozzi/obsidian-marp-slides/badge)](https://www.codefactor.io/repository/github/samuele-cozzi/obsidian-marp-slides)[![Maintainability](https://api.codeclimate.com/v1/badges/78932986b29ffe273e56/maintainability)](https://codeclimate.com/github/samuele-cozzi/obsidian-marp-slides/maintainability)[![Test Coverage](https://api.codeclimate.com/v1/badges/78932986b29ffe273e56/test_coverage)](https://codeclimate.com/github/samuele-cozzi/obsidian-marp-slides/test_coverage)[![LICENSE](https://img.shields.io/github/license/samuele-cozzi/obsidian-marp-slides)](https://github.com/samuele-cozzi/obsidian-marp-slides/blob/main/LICENSE)
<!-- ![Obsidian Downloads](https://img.shields.io/badge/dynamic/json?logo=obsidian&color=%23483699&label=downloads&query=%24%5B%22better-word-count%22%5D.downloads&url=https%3A%2F%2Fraw.githubusercontent.com%2Fobsidianmd%2Fobsidian-releases%2Fmaster%2Fcommunity-plugin-stats.json&style=for-the-badge) -->

Marp Slides is very simple & powerful slide deck extension for [Obsidian](href="https://obsidian.md") based on [Marp](https://marp.app/). View the **[DOCS](https://samuele-cozzi.github.io/obsidian-marp-slides/)** for [getting started](https://samuele-cozzi.github.io/obsidian-marp-slides/10.GettingStarted.html)

![Alt text](docs/pictures/CreateSlides.gif)

See the documentation of [Marpit Markdown](https://marpit.marp.app/markdown) and [the features of Marp Core](https://github.com/marp-team/marp-core#features) about how to write.
Marp have powerful tools for Markdown Slides: [Marpit Framework](https://marpit.marp.app/), [CLI tool](https://github.com/marp-team/marp-cli), [Web interface](https://web.marp.app/) and so on.

## Getting Started

- [Read Documentation](https://samuele-cozzi.github.io/obsidian-marp-slides/)
- [View the demo Presentation](https://samuele-cozzi.github.io/obsidian-marp-slides/pictures/Sample%20Pro%201.html)

## Features

- [Preview Slides](https://samuele-cozzi.github.io/obsidian-marp-slides/21.SlidesPreview.html)
- [Export slide deck (html, pdf, pptx, img)](https://samuele-cozzi.github.io/obsidian-marp-slides/22.SlidesExport.html) using Marp cli API
- [Use custom theme CSS](https://samuele-cozzi.github.io/obsidian-marp-slides/23.SlidesCustomTheme.html)
- [Presenting](https://samuele-cozzi.github.io/obsidian-marp-slides/24.Presenting.html)

![Alt text](docs/pictures/ThemeSlides.gif)

> ⚠️ Export except HTML requires to install any one of [Google Chrome](https://www.google.com/chrome/), [Chromium](https://www.chromium.org/), or [Microsoft Edge](https://www.microsoft.com/edge). You may also specify the custom path for Chrome / Chromium-based browser by preference `CHEROME_PATH`.

## Not supported

- Wiki Link
- Mobile App Plugin is in Alpha Version

## Many Thanks 👏

- [plugin obsidian development docs](https://marcus.se.net/obsidian-plugin-docs/)
- [marp vs code](https://github.com/marp-team/marp-vscode)
- [obsidian api](https://github.com/obsidianmd/obsidian-api)