jsonMartin / readwise-mirror

MIT License
53 stars 12 forks source link

Format for highlights is substantially different from the Readwise manual markdown export #9

Closed thomasvs closed 3 years ago

thomasvs commented 3 years ago

I just realized that the markdown this plugin exports is substantially different from the Readwise export.

In particular:

For example, here is a snippet of the export I get from Readwise:

Highlights

Here is the start of the snippet I get from this plugin:

Highlights

INTRODUCTION (102) %% Color: yellow %% ^203951410

Note: .h1


PART I WHAT IS POSITIVE INTELLIGENCE AND PQ? (128) %% Color: yellow %% ^203951411

Note: .h1


CHAPTER 1 POSITIVE INTELLIGENCE AND PQ (130) %% Color: yellow %% ^203951412

Note: .h2


“What do we need to do so that within three years we can say this current crisis was the best thing that could have happened to our company?” (2191) %% Color: yellow %% ^203951413


PQ stands for Positive Intelligence Quotient. Your PQ is your Positive Intelligence score, expressed as a percentage, ranging from 0 to 100. In effect, your PQ is the percentage of time your mind is acting as your friend rather than as your enemy; or, in other words, it is the percentage of time your mind is serving you versus sabotaging you. (161) %% Color: yellow %% ^203951415


jsonMartin commented 3 years ago

Hi @thomasvs , this plugin wasn't necessarily intended to provide an exact 1:1 export compared to the Markdown format from Readwise; their export feature has many other capabilities such as templating engine. Readwise's API returns plain unformatted text per highlight, not a formatted document - their Markdown export format is only directly available through their website.

FYI, I also haven't used Heading Tags myself, so did not add any custom code to support this.

However, customization of highlight documents will be possible when templating engine is added in a future release, please track this issue here for updates: https://github.com/jsonMartin/readwise-mirror/issues/11

Also, Readwise has just released their official Obsidian plugin last week, so if controlling the formatting of the notes is more important to your needs than the mirror syncing functionality this plugin provides, you might want to consider using their plugin instead: https://help.readwise.io/article/125-how-does-the-readwise-to-obsidian-export-integration-work