113 lines
2.5 KiB
Markdown
113 lines
2.5 KiB
Markdown
---
|
||
categories:
|
||
- "[[Marp]]"
|
||
tags:
|
||
- marp
|
||
- obsidian
|
||
- plugin
|
||
created: 2026-04-07
|
||
source: "[[marp-guide]]"
|
||
type: reference
|
||
aliases:
|
||
- Obsidian Marp
|
||
- Marp Obsidian
|
||
---
|
||
|
||
# Obsidian Marp 插件
|
||
|
||
> 在 Obsidian 中实时预览和导出 Marp 幻灯片。
|
||
|
||
## 基本信息
|
||
|
||
- **仓库**：[JichouP/obsidian-marp-plugin](https://github.com/JichouP/obsidian-marp-plugin)
|
||
- **功能**：预览 + 导出（PDF/PPTX/HTML）
|
||
- **前置要求**：Node.js（导出功能需要）
|
||
|
||
## 核心功能
|
||
|
||
### 1. 实时预览
|
||
|
||
- 点击侧边栏的 Marp 图标，或
|
||
- 命令面板运行 `Marp: Open Preview`
|
||
- 支持分栏预览（一边编辑一边看效果）
|
||
- 保存文件后自动刷新
|
||
|
||
### 2. 导出
|
||
|
||
- 支持格式：PDF、PPTX、HTML
|
||
- 输出目录：固定为 `Downloads`
|
||
- 图片自动转 Base64 嵌入
|
||
- HTML 格式支持页面过渡动画
|
||
|
||
### 3. 图片支持
|
||
|
||
两种格式都支持：
|
||
|
||
```markdown
|
||
<!-- Wikilink 格式 -->
|
||
![[path/to/image.png]]
|
||
|
||
<!-- CommonMark 格式 -->
|
||
|
||
```
|
||
|
||
路径支持绝对路径和相对路径（相对于 vault 根目录）。
|
||
|
||
## 设置项
|
||
|
||
| 设置 | 类型 | 默认值 | 说明 |
|
||
|------|------|--------|------|
|
||
| Enable Auto Reload | toggle | on | 保存时自动刷新预览 |
|
||
| Open Preview in Split Tab | toggle | on | 分栏打开预览 |
|
||
| Theme Folder Location | text | `MarpTheme` | 自定义主题 CSS 目录路径（建议设为 `Templates/MarpTheme`） |
|
||
|
||
## 自定义主题
|
||
|
||
在 vault 中创建主题目录（插件设置中 Theme Folder Location 默认为 `MarpTheme`）：
|
||
|
||
```
|
||
<vault>/
|
||
└── Templates/
|
||
└── MarpTheme/
|
||
├── beamer.css
|
||
└── gradient.css
|
||
```
|
||
|
||
> [!tip] 插件设置中的 Theme Folder Location 应配置为 `Templates/MarpTheme`。
|
||
|
||
然后在幻灯片中使用：
|
||
|
||
```markdown
|
||
---
|
||
marp: "true"
|
||
theme: beamer
|
||
---
|
||
```
|
||
|
||
> [!warning] 添加新 CSS 文件后需要**重启 Obsidian** 才能识别。
|
||
|
||
## 工作流程
|
||
|
||
```mermaid
|
||
graph LR
|
||
A["📝 编辑 .md"] --> B["👁️ Marp 预览"]
|
||
B --> C["满意？"]
|
||
C -->|是| D["📤 导出"]
|
||
C -->|否| A
|
||
D --> E["📄 PDF/PPTX/HTML"]
|
||
```
|
||
|
||
## 使用前检查清单
|
||
|
||
- [ ] 安装 Obsidian Marp 插件（社区插件市场搜索 "Marp"）
|
||
- [ ] 安装 Node.js（导出功能需要）
|
||
- [ ] 在 Markdown 文件 front-matter 中加 `marp: "true"`
|
||
- [ ] 用 `---` 分页
|
||
|
||
## 相关页面
|
||
|
||
- [[Marp]] — Marp 概念总览
|
||
- [[Marp 指令语法]] — 完整指令参考
|
||
- [[Marp 主题与样式]] — 主题和 CSS 自定义
|
||
- [[Marp 导出]] — 所有导出方式对比
|