Obsidian provides the option of providing metadata about your note as YAML front matter. Obsidian to Reader interprets some of these metadata points to finetune how your note gets sent to Reader.

Key Example Description
author author: Jörn Reader will show this as the author field in your document1.
image-url or banner image-url: https://tinyurl.com/ydwfhwpn If you provide a URL here, it will get used as the cover image for your Reader document.
reader-url reader-url: https://read.readwise.io/new/read/123 After publishing to Reader, Obsidian to Reader will save the Reader document’s URL to the front matter2.
source source: https://obsidiantoreader.com By default, Obsidian to Reader will provide a source URL to Reader that will link back to your Obsidian note. If you want to provide a different source, you can do so with this front matter.
summary summary: A short description This will get used as the summary, the short teaser text that Reader will show in the list view.
title title: My document title Will show up as the title of your Reader document.

  1. If no author is set in the front matter, you can also provide one with the Fallback author setting. ↩︎

  2. If the Save URL in front matter setting is set ↩︎