No description
Find a file
2023-03-04 08:42:14 +01:00
src fix for when you don't have any collection set on a book 2023-02-08 21:56:32 +01:00
test-vault fixed re-login with a refresh token (I did not yet reverse-engineer that request yet) 2023-02-08 21:11:53 +01:00
.editorconfig first working version of the plugin 2023-01-28 23:27:57 +01:00
.eslintignore Initial commit 2023-01-26 21:58:49 +01:00
.eslintrc Initial commit 2023-01-26 21:58:49 +01:00
.gitignore first working version of the plugin 2023-01-28 23:27:57 +01:00
.npmrc Initial commit 2023-01-26 21:58:49 +01:00
.prettierrc first working version of the plugin 2023-01-28 23:27:57 +01:00
esbuild.config.mjs first working version of the plugin 2023-01-28 23:27:57 +01:00
manifest.json adds support link to buy me a pizza 2023-03-04 08:42:14 +01:00
package-lock.json moved to using a yaml lib instead of manually mangling the yaml 2023-01-29 09:36:00 +01:00
package.json moved to using a yaml lib instead of manually mangling the yaml 2023-01-29 09:36:00 +01:00
README.md no direct password storage anymore 2023-02-05 21:05:56 +01:00
tsconfig.json first working version of the plugin 2023-01-28 23:27:57 +01:00
version-bump.mjs Initial commit 2023-01-26 21:58:49 +01:00
versions.json Initial commit 2023-01-26 21:58:49 +01:00

Obsidian Pocketbook Cloud Highlights Plugin

This is a plugin for Obsidian (https://obsidian.md) to import highlights that you made on your Pocketbook E-Ink reader, or in the Pocketbook App on your phone.

Requires the "dataview" plugin to work correctly - and does not check that it's installed ;-). Only works for "login with password".

Adding your plugin to the community plugin list

How to use

  • Clone this repo.
  • npm i or yarn to install dependencies
  • npm run dev to start compilation in watch mode.

Manually installing the plugin

  • Copy over main.js, styles.css, manifest.json to your vault VaultFolder/.obsidian/plugins/your-plugin-id/.

Improve code quality with eslint (optional)

  • ESLint is a tool that analyzes your code to quickly find problems. You can run ESLint against your plugin to find common bugs and ways to improve your code.
  • To use eslint with this project, make sure to install eslint from terminal:
    • npm install -g eslint
  • To use eslint to analyze this project use this command:
    • eslint main.ts
    • eslint will then create a report with suggestions for code improvement by file and line number.
  • If your source code is in a folder, such as src, you can use eslint with this command to analyze all files in that folder:
    • eslint .\src\

Funding URL

You can include funding URLs where people who use your plugin can financially support it.

The simple way is to set the fundingUrl field to your link in your manifest.json file:

{
  "fundingUrl": "https://buymeacoffee.com"
}

If you have multiple URLs, you can also do:

{
  "fundingUrl": {
    "Buy Me a Coffee": "https://buymeacoffee.com",
    "GitHub Sponsor": "https://github.com/sponsors",
    "Patreon": "https://www.patreon.com/"
  }
}

API Documentation

See https://github.com/obsidianmd/obsidian-api