https://github.com/JichouP/obsidian-marp-plugin

Plugin to use Marp with Obsidian
https://github.com/JichouP/obsidian-marp-plugin

obsidian-md obsidian-plugin typescript

Last synced: about 2 months ago
JSON representation

Plugin to use Marp with Obsidian

• Host: GitHub
• URL: https://github.com/JichouP/obsidian-marp-plugin
• Owner: JichouP
• License: mit
• Created: 2023-02-22T17:29:44.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-21T08:58:02.000Z (6 months ago)
• Last Synced: 2024-08-02T20:45:48.402Z (5 months ago)
• Topics: obsidian-md, obsidian-plugin, typescript
• Language: TypeScript
• Homepage:
• Size: 3.48 MB
• Stars: 119
• Watchers: 1
• Forks: 9
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-marp - Obsidian Marp Plugin - Yet another plugin for Obsidian. (Ecosystem / Community)

README

        
# Obsidian Marp Plugin

Plugin to use [Marp](https://marp.app/) with [Obsidian.md](https://obsidian.md/).

## Open the Preview

Select the tab for the Markdown file, then click the button on the ribbon or run `Marp: Open Preview` from the command palette to see a preview.

![open_preview](docs/open_preview.gif)

### Auto Reload

![auto_reload](docs/auto_reload.gif)

## Export Slides

**You need to have Node.js installed to export slides, as this plugin uses the `npx` command to export slides.**  

You can choose your preferred format from PDF, PPTX and HTML.  

**The output is always to the `Downloads` directory.**

![export](docs/export.gif)

## Embed Images

When exporting, images are converted to Base64 and embedded in the file, so you can share slides with embedded local images.  

The image path can be an absolute or relative path from the root of the vault.  

You can use both Wikilink format (`![[path/to/image.png]]`) and CommomMark format (`![alt](path/to/image.png)`).

## Transition

![transition](docs/transition.gif)

Transitions can be used by exporting in HTML format.

However, you need to set the `viewTransition API` to `Enable` in Chrome 110.

(Not required if you are using the beta version (111+) of Chrome.)

![enable_view_transitions_api](docs/enable_view_transitions_api.png)

## Settings

### Enable Auto Reload

type: toggle  

default: on

If on, the preview will be updated automatically when the Markdown file is saved.

### Enable Open Preview in Split Tab

type: toggle  

default: on

Enables the ability to open previews in split tabs. If disabled, a new tab will be created in the same split as the markdown file.

### Theme Folder Location

type: text

default: `MarpTheme`

Specify the relative path to the directory where the theme is stored. By saving the css files in the specified directory, Marp can use a custom theme.

**\*Obsidian must be restarted after adding css.**

#### Example: If you set `MarpTheme` as `Theme Folder Location`

```text

└── MarpTheme  ← Make this directory

    ├── beamer.css  ← Then save custom css here!

    ├── border.css

    └── gradient.css

```