Skip to content

Releases: jsonMartin/readwise-mirror

1.5.0-beta.19

24 Mar 11:27
Compare
Choose a tag to compare
1.5.0-beta.19 Pre-release
Pre-release

1.5.0-beta.19 (2025-03-24)

Bug Fixes

  • 🐛 fix a regression with double names ("First-First", "Last-Last") (aae443f)

1.5.0-beta.1

24 Jan 19:08
8ff2277
Compare
Choose a tag to compare
1.5.0-beta.1 Pre-release
Pre-release

1.5.0-beta.1 (2025-01-24)

Release notes (beta)

  • switches to the “export” API, which makes the document and summary available, adds additional metadata (created, updated, and (last) highlighted date across the board) - #39,
  • adds documentation to the different templates within the plugin options in Obsidian,
  • implements two additional nunjucks filters (is_qa, qa) which can be used to parse and reassemble “Q & A” blocks defined with the .qa action tag in a note,
  • includes improvements for title and author as well as sanitized_title and authorStr when used in the frontmatter template
  • adds a feature to deduplicate items (locally and remotely), using the unique Readwise URL in frontmatter
  • implements features to parse, keep, and protect frontmatter on updates (needed for deduplication, but useful to keep additional fields around when updating),
  • driven by the needs of these two features, validates the frontmatter template in the settings UI to make sure we can use it when the plugin is run,
  • implements a feature to slugify - #27
  • uses filenamify to create valid filenames and limit them to 255 characters - #37
  • adds the relevant additional documentation

In terms of housekeeping, this patch

  • implements a semantic-release workflow, using the brianrodri/semantic-release-obsidian-plugin, which can be used to deploy semantic versions, including beta releases
  • adds local deploy and release actions, as well as a GitHub workflow that automatically runs a release on the master resp. main branches (Since incorporating this, I've moved the semantic-release config into a separate .realeaserc.yaml to stop polluting package.json and I also removed committing manifest.json, versions.json and package[-lock].json as this (not suprisingly) created quite a bit of issues when merging branches).
  • restructures the code to make it more modular (separating settings from the main class),

Readwise Mirror 1.4.11

28 Oct 19:11
Compare
Choose a tag to compare

Minor UI update: Change "Open in Readwise" default Highlight text to "View Highlight", which aligns semantically with expected behavior & official plugin output

Readwise Mirror 1.4.1

27 Oct 22:52
Compare
Choose a tag to compare

This update adds better support for Readwise article highlighting and default tag template additions. Thanks to first time contributor @tdznr for adding to this release!

  • Feature: Add "Open in Readwise" link when Readwise url field is present.
    • The url field contains the link to Readwise's website showing the highlighted snippet in its source context.
    • The url field is not available for book types, but is available for other content types such as Articles.
  • Feature: Show tags in default highlight template

Readwise Mirror 1.4.0

18 Aug 22:50
Compare
Choose a tag to compare

1.4.0 (2023-08-18)

Thanks to @johannrichard for the following contributions:

Features

  • Feature: ✨ add frontmatter tag field
  • Feature: ✨ roll-up of highlight tags into frontmatter
    • a rolled-up (deduplicated) list highlight tags can be used in frontmatter via the field quoted_highlight_tags
  • Feature: ✨ user setting for "colon" (:) replacement
    • The colon in a title is a special character which by default is replaced witha a dash (-) in filenames. With this change, users can choose what string to use as a replacement.
  • Feature: ✨ Multi-line text can be filtered with the bq filter
    • The filter adds the > character after each line-break
    • With this, you can get multi-line text blockquotes in your templates working correctly

      Example

      The following highlight
      Multi-line text in blockquotes
      
      This is an example of a multi-line highlight with line-breaks. 
      
      ... with this template
      > [!quote]
      > {{ text | bq }}
      
      will turn into
      > [!quote]
      > Multi-line text in blockquotes
      >
      > This is an example of a multi-line highlight with line-breaks. 

Updates

  • Change field names to reflect their use in frontmatter
  • Introduce option for quotes in tag format
    • make tag formatting more flexible
    • avoid adding quotes all the time
    • differentiate nohas from quoting
  • Introduce option for quotes in tag format

Readwise Mirror 1.3.0

11 Dec 03:07
Compare
Choose a tag to compare

This release contains 2 new features: Sort Highlights By Location (#10), and Filter Discarded Highlights (#17)

Sort Highlights by Location (instead of date highlighted).

  • This will display highlights in order of page location, from least to greatest.
  • Combine with Sort Highlights from Oldest to Newest to reverse the sort order.

Filter Discarded Highlights.

  • With this option enabled, highlights that have been discarded in Readwise will not be displayed in the Obsidian library.

Readwise Mirror Version 1.2.0

13 Feb 00:41
Compare
Choose a tag to compare

This release contains 2 new features: Templating mode, and a "Zettelkasten" (or "literary notes") mode (#12). Thanks @johannrichard for the PR!

Templating Mode

The plugin allows for simple templating, and uses Nunjucks. Similarly to Readwise's templating, it allows to define a header template, a highlight template, and a template for frontmatter. The frontmatter template can be turned on and off. If you want to revert to the default template, you can just empty the template completely and the plugin will restore the default.

See ReadMe for further templating syntax and details.

Zettelkasten Mode

A lot of the value of Readwise highlights lies in the notes associated with them. E.g. if you are building a Zettelkasten and want to work with literature notes, you typically only want highlights with notes in your Zettelkasten -- and not every highlight.

The option "Only sync highlights with notes" will do exactly that: it will only sync highlights with notes. If an item in your library has only highlights without notes, it will not be synced.

Readwise Mirror Version 1.1.1

02 Aug 02:58
Compare
Choose a tag to compare

1.1.1 (2021-08-01)

Added

  • Added Sync Log functionality. Creates a file (configurable, with a default filename of Sync.md) in the Readwise library root folder, which stores a time-based log listing when Readwise sources have synced new highlights

Readwise Mirror Version 1.1.0

25 Jun 00:55
Compare
Choose a tag to compare

1.1.0 (2021-06-24)

Added

  • Added tag support, both in highlights as well as sources (books, articles, etc)

Readwise Sync Version 1.0.2

29 May 00:42
Compare
Choose a tag to compare

1.0.2 (2021-05-24)

Fixed

  • Fixed linking bug when illegal characters were stripped in filename, but not in Note title (#4)

Changed

  • Starting default sort order preference now sorts highlights chronologically from oldest to newest