Obsidian Exporter Processor Module (obsidian_export.py)

[allenporter]

Build background processor module auto-generating Markdown (.md) files, frontmatter, page PNG embeds, and OCR transcriptions in Obsidian vault folder.

[allenporter]

Detailed Technical Implementation Plan

1. User Journeys & Example Use Cases

• Journey A: Automated Obsidian Vault Mirroring
  • Scenario: User creates a handwritten notebook on E-ink device at Note/Projects/Architecture.note.
  • Workflow:
    1. User syncs E-ink device with Supernote Private Cloud server.
    2. Background processing pipeline extracts page images, runs Gemini Vision OCR, and calls ObsidianExportModule.
    3. The module generates Architecture.md and .attachments/Architecture/page_1.png inside the target Obsidian vault directory (/data/obsidian/Supernote/Projects/).
  • Outcome: In Obsidian, the user can immediately search handwritten text, view page render PNGs, link notes using [[Architecture]], and process checkboxes.

---

2. Requirements & Technical Specifications

A. Exporter Module (supernote/server/services/processor_modules/obsidian_export.py)

• Module Signature: Implement standard ProcessorModule interface:

  class ObsidianExportModule(ProcessorModule):
      async def process(self, context: ProcessingContext) -> None: ...

• Config Options (config.yaml):

  obsidian:
    enabled: true
    vault_path: "/data/obsidian/Supernote"
    embed_images: true
    image_format: "png"

B. Markdown Template & Frontmatter Schema

---
title: "Architecture"
supernote_path: "Note/Projects/Architecture.note"
pages: 2
created: 2026-08-02T06:30:00Z
updated: 2026-08-02T06:50:00Z
tags:
  - supernote
  - project
---

# Architecture

> [!INFO] Notebook Metadata
> **Source Note**: `Note/Projects/Architecture.note` | **Pages**: 2

## 📋 Action Items
- [ ] Review WebDAV endpoints

## Page 1
![[.attachments/Architecture/page_1.png|600]]

### Transcription
Meeting notes on server architecture...

C. Atomic File Writes & File Handling

• Write page images to .attachments/<notebook_name>/page_<index>.png.
• Write .md files atomically using temporary files to prevent race conditions with file watchers (Obsidian / Syncthing).

---

3. Verification & Testing Plan

• Automated Unit Tests (tests/server/test_obsidian_export.py):
  • Test Markdown formatting and valid YAML frontmatter generation.
  • Test directory creation and relative image path references.
  • Test handling notebook rename / page count changes.