Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
duydl committed Aug 11, 2024
1 parent 5e4a506 commit c32bb8b
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[Support my work](https://www.buymeacoffee.com/duydole00) if you find this helpful!


# Logseq Calibre Annotation

> Now also with features from [`calibreMetadata`](https://github.com/duydl/logseq-calibre-metadata).
Expand All @@ -8,6 +9,19 @@ Enhance your note-taking experience with Logseq by integrating with [Calibre](ht

- **Calibre Content Server** is a convenient tool for reading e-books in browsers and syncing reading progress and annotations across devices. Now, book metadata and annotations from Calibre can seamlessly sync to your Logseq graph.

**Table of Content**
- [Usage](#usage)
- [1. Adding Books](#1-adding-books)
- [2. Opening Viewer](#2-opening-viewer)
- [3. Syncing Annotations](#3-syncing-annotations)
- [4. Authentication for User Login](#4-authentication-for-user-login)
- [5. Additional Tips](#5-additional-tips)
- [Demo](#demo)
- [Import Books](#import-books)
- [Viewing and Syncing](#viewing-and-syncing)
- [Copy Individual Annotations](#copy-individual-annotations)
- [Contribution](#contribution)

## Usage

The `calibreAnnotation` plugin introduces a slash command, `Calibre Annotation: Add a Calibre book`, for importing books from Calibre into Logseq with formats similar to Zotero's.
Expand Down Expand Up @@ -67,7 +81,7 @@ You can configure the authentication settings of the plugin as follows:
3. In the **Template for citing highlighted text**, add the following:

```plaintext
{{{{renderer calibreViewer, {style_kind}, {url}}}}} {text}
{{{{renderer calibreViewer, {style_which}, {url}}}}} {text}
{notes}
```
Expand Down Expand Up @@ -117,6 +131,17 @@ You can configure the authentication settings of the plugin as follows:
</tr>
</table>
### Copy Individual Annotations
<table align="center" style="width: auto; margin: 0 auto;">
<tr>
<td align="center"><img src="screenshots/demo4.gif" alt="Copy Individual Annotations from Viewer" style="width: 60%;"></td>
</tr>
<tr>
<td align="center"><strong>Copy Individual Annotations from Viewer</strong></td>
</tr>
</table>
## Contribution
Expand Down
Binary file added screenshots/demo4.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c32bb8b

Please sign in to comment.