omnivore-app / logseq-omnivore

Logseq plugin to fetch articles and highlights from Omnivore

日本語

logseq-omnivore

This plugin enables importing and syncing web clippings, articles, and highlights from the web app Omnivore.app (its server) into a Logseq graph.

Utilizing "Omnivore.app"

1. Register for an account on Omnivore.app.
   • "Omnivore.app" functions as a web tool (web app) specifically designed for web clippings. Instead of simply bookmarking interesting pages in a browser, users can manage them as web clippings, alongside highlights, and organize multiple sites.
     • This application is available for free on both desktop and mobile devices, and web clipping data is stored on the server (cloud). With this plugin, one can import and save this data in Logseq. Additionally, any attached notes related to the articles can also be imported.

Showcase

• Sorted by Date: In Logseq, web clippings and highlights are automatically categorized based on their respective dates.
• Tagging and Referencing: Labels attached to web clippings act as tags with links, allowing users to associate web-clipped pages and their highlights with existing pages (displayed in the "Linked References" section of the page).

  Labeling can be done in Omnivore.app, permitting users to group articles. These labels serve the same role as linking to pages within the Logseq graph but only for articles imported from Omnivore.app to Logseq.

• Filtering: Article data can be filtered using advanced search syntax.
• As a Storage Location for Web Clippings: Create a graph based on article data from Omnivore.app.

  Whether one wants to add it to an existing graph or create a new one.

• Customization: Custom templates for article data.

Usage Instructions

1. Typically, the plugin is installed from the marketplace.
2. Once the plugin is enabled, the API key issuance page will open (Omnivore's API Key Issuance Page).
3. Open the plugin settings and register the API key.
4. Click the 🔨 button in the top right toolbar to enable the Omnivore toolbar icon. Clicking that icon opens the [[Omnivore]] page, and synchronization begins at that point. This process may take some time.

   If there are no articles in Omnivore.app's INBOX, importing articles won't be possible. Therefore, it's recommended to add articles to Omnivore.app's INBOX first.

Synchronization Details

1. The plugin generates a dedicated page named "Omnivore" for synchronization.
2. Content with highlights and additional notes added in Omnivore.app is inserted into article blocks, and custom templates from the plugin settings are applied. This includes attribute data and label links.
3. Synchronization Timing: Synchronization with Omnivore.app starts when the plugin is opened and whenever changes are made to the settings.

   Moreover, adjustments to the API key, search filters, and synchronization frequency can be made in the plugin settings. Manual synchronization with Omnivore.app can also be initiated by clicking the Omnivore icon in the toolbar.

Demo

Fetching

Settings

Contacts

Developer: Hongbo Wu @ Omnivore

Contributing

• Kudos to @Brian for the great guide on how to use Omnivore.app and this plugin. Chinese translation by @吴洪博, Japanese translation by YU000jp

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT

FAQ

I got TypeError: Cannot read properties of null (reading:’uuid’) when trying to fetch articles.

This has been fixed in the latest version of the plugin. If you still encounter this issue, please try to click on the empty block on the "Omnivore" page.

The button to sync with Omnivore is not working after updating settings.

This has been fixed in the latest version of the plugin. If you still encounter this issue, please try to reload the plugin and if it is still not working, please open on issue.