README file from
GithubFeedly Annotations Sync
If you are a paid member of Feedly, you are able to annotate articles and add comments to them as well. Those are all stored in Feedly's web UI. This plugin makes it easy for users to sync these annotations and comments to a folder in Obsidian, with a file created for each article and each file containing as many highlights as you've added.
Setup
- Sign into Feedly and get a developer access token
- Take note of your user ID and access token
- Save those values in the plugin settings
- Run Feedly Annotations Sync: Sync Annotated Articles
Note: Your access token expires after a month. Then you must obtain a new one.
Feedly's API has a daily rate limit. So the first time you run the sync, it may end with a 429 error before being complete. If so, then the plugin will pick back up in the same spot tomorrow.
By default, all files will be placed in a directory called Feedly Annotations but that can be changed in the plugin settings.
Example
You open up the command palette and run the Feedly Annotationns Sync command. Each file will include frontmatter metadata which includes pertinent information and is followed by annotations in quotes and comments.
Example: Feedly Annotations/How Will AI Affect the Semiconductor Industry.md
---
url: https://spectrum.ieee.org/how-will-ai-change-semiconductors
feedlyUrl: https://feedly.com/i/entry/qVaITo2WE8WUK65sE/5QyhWry8ByR703aSjyCZVKs9g=_18bd413beb9:26e5afa:1883a5ef
date: 2023-11-23
pubDate: 2023-11-15
author: Tekla S. Perry
publisher: IEEE Spectrum
---
> Gavrielov recalled the transition to electronic-design automation (EDA), the last big change in chip design. That transition, he says, was a 30-plus-year process. “I think the transition that AI will bring will happen in a third to a fifth of the time and will have a much bigger impact,” he said. “In five years, for sure in less than 10 years, design will be done in a very different way than today.”
The date refers to the date of the annotations whereas pubDate is the actual date of publication.
This plugin could use your feedback and help to make it a success!
EPub Generation
For offline reading, you can use Obsidian to generate an ePub file which
contains every unread article (and every saved item no older than a month).
This file will be located in your main directory with the file pattern
FeedlySync-(Timestamp).epub.
Every article becomes its own chapter in the file. Images are removed from this file to keep the filesize low.
You can use the command palette to generate a new Feedly ePub file or delete all of the Feedly Sync ePub files currently in your vault.
When generating ePub files, one can also include Instapaper as a source. These articles are appended at the end.
Instapaper Integration (Optional)
You can optionally connect your Instapaper account (using Instapaper API v2) to include unread bookmarks in generated ePubs, sync custom folders into a Markdown reading list, and save links directly from Obsidian.
Setup
- Go to Instapaper Developer Applications and register a personal application (or select an existing one).
- Generate a Personal Access Token on your application's page.
- Paste the token into Instapaper access token in the plugin settings.
Features
- Include in ePubs: Unread Instapaper articles (up to your configured Instapaper bookmark limit) are automatically fetched, parsed, and appended when running Generate ePub.
- Sync Folders to Markdown: Run Sync Instapaper folders to Markdown list to export bookmarks from your custom Instapaper folders into a grouped Markdown file (defaults to
Instapaper Folders.mdin your sync directory). - Save Links to Instapaper: Right-click any URL in Obsidian and select Add to Instapaper from the context menu.
Testing
To run the integration test suite against the live Instapaper API v2 and Feedly APIs:
- Copy
.env.exampleto.env(which is git-ignored):cp .env.example .env - Fill in your
INSTAPAPER_ACCESS_TOKEN,FEEDLY_ACCESS_TOKEN, andFEEDLY_USER_IDin.env. - Run the tests:
npm test