Ob2Red

unlisted

by jianghaibo

Export notes to Xiaohongshu images with smart pagination.

Updated 6mo agoMIT
View on GitHub

Ob2Red

Export Obsidian notes to Xiaohongshu (小红书) style images with smart pagination and optional AI-powered card restructuring.

Obsidian License

Features

  • Smart Pagination — Automatically splits long notes into multiple pages with proper content breaks
  • AI Smart Cards — Optionally send the note to an OpenAI-compatible model, restructure it into Xiaohongshu-style cards, and render with preset visual styles
  • Live Preview — Real-time preview in the right sidebar
  • 4 Built-in Themes — 极简白底 / 奶油暖色 / 深色高端 / 荧光标记
  • 4 Smart Card Styles — 暖白知识卡 / 数据简报蓝 / 深色科技感 / 高亮便签风
  • Two Image Sizes — 1080×1440 (3:4) and 1080×1920 (9:16)
  • Cover & End Pages — Auto-generated cover with title and customizable end page
  • Export Single or All — Export the current page or all pages at once
  • Obsidian Callout Support — Renders Obsidian callouts (> [!note], > [!tip], etc.) with themed styling
  • Frontmatter Overrides — Per-note theme/size/author customization via YAML frontmatter

Usage

  1. Open a Markdown note in Obsidian
  2. Click the camera icon in the left ribbon, or use the command palette: Ob2Red: 导出为小红书图片
  3. The preview panel opens in the right sidebar
  4. Select a theme or smart-card style and image size, browse pages via thumbnails
  5. Click 导出当前页 or 导出全部 to save as PNG images

Frontmatter Overrides

Override plugin settings on a per-note basis:

---
ob2red:
  theme: cream-warm          # minimal-white | cream-warm | dark-elegant | highlight-pop
  size: 1080x1920            # 1080x1440 | 1080x1920
  author: Your Name
  cover-subtitle: A subtitle
  show-cover: true
  show-end-page: false
---

Themes

ThemeDescription
minimal-whiteClean white background with minimal styling
cream-warmWarm cream tones for a cozy reading feel
dark-elegantDark background with elegant typography
highlight-popBright highlights and bold accents

Smart Cards

Enable smart cards in plugin settings, then configure:

  • Base URL — OpenAI-compatible API base URL
  • API Key — API key for the model service
  • Model — Model name to call
  • 内容编排风格 — How the LLM restructures content
  • 卡片视觉样式 — Preset rendering style; switching style does not regenerate content

Installation

From Obsidian Community Plugins

  1. Open Obsidian Settings → Community Plugins → Browse
  2. Search for Ob2Red
  3. Click Install, then Enable

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the latest release
  2. Create a folder ob2red in your vault's .obsidian/plugins/ directory
  3. Copy the downloaded files into that folder
  4. Restart Obsidian and enable the plugin in Settings → Community Plugins

License

MIT

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.