Readwise Mirror is an unoffical open source plugin for the powerful note-taking and knowledge-base application Obsidian. This plugin allows a user to "mirror" their entire Readwise library by automatically downloading all highlights/notes and syncing changes directly into an Obsidian vault.

Its advanced features allow you to keep internal links to your Readwise notes intact across syncs, protect or update frontmatter properties in your notes, and define custom filenames based on each Readwise item's properties.

This Wiki contains documentation about advanced features, such as filtering by tags, tracking files, and the powerful templating that distinguish it from the official Readwise plugin for Obsidian.

The plugin can be configured via numerous settings and has different, advanced features that will allow for better integration of your Readwise highlights into your Obsidian vault. Please make sure you read the documentation pages in the Wiki:

• Installation & Setup: How to install the Readwise Mirror plugin, authenticating your Readwise account, and performing your first sync.
• Guide: File Tracking & Naming: Learn how to configure filenames and prevent broken links.
• Guide: Templating: Format your notes exactly how you want them.
• Guide: Frontmatter Management: Advanced features for a better experience in Obsidian.

You also might want to check out some of the advanced Recipes to make the best use of the plugin.

Once installed and configured, the plugin offers the following commands in Obsidian:

• Sync new highlights: Download all new highlights since previous update
• Download entire Readwise library (force) : Forces a full download of all content from Readwise
• Update all Readwise note frontmatter: Scan all notes in your Readwise library folder and update their frontmatter according to your current frontmatter template and protection settings, without changing the note content or filename. This is useful after changing your frontmatter template or protection settings. Command is only available if file tracking and frontmatter are enabled.
• Update current note: Update the currently selected note based on the Readwise tracking property. Command is only available when file tracking is enabled.

Those should be rarely needed, but offer convenience functions for special cases:

• Delete Readwise library: Remove the Readwise library file folder from the Obsidian vault
• Test Readwise API key: Ensure the Access Token works
• Adjust filenames to current settings: Clean up filenames of existing notes in your Readwise library folder based on current filename settings (whitespace removal and slugify only for the time being)