☠️ THIS PROJECT IS NO LONGER MAINTAINED ☠️
Please use gatsby-source-pocketapi instead 🚀
Fetch data from Pocket API.
An example site for this plugin is available:
- v3.x - for
Gatsby@4 - v2.x - for
Gatsby@3and lower
-
npm install --save gatsby-source-pocket -
Go to https://getpocket.com/developer/ and create a new app to get your consumer key.
-
Run
node node_modules/node-getpocket/authorise --consumerkey 'YOUR-CONSUMER-KEY'and point your browser to http://127.0.0.1:8080to get yourPOCKET_ACCESS_TOKENstring.For more info on this process see https://github.com/vicchi/node-getpocket, which this plugin uses to talk to the Pocket API.
-
In your gatsby-config.js
module.exports = {
plugins: [
{
resolve: `gatsby-source-pocket`,
options: {
consumerKey: INSERT_HERE_YOUR_POCKET_CONSUMER_KEY,
accessToken: INSERT_HERE_YOUR_POCKET_ACCESS_TOKEN,
weeksOfHistory: 52,
apiMaxRecordsToReturn: 3000,
getCurrentWeekOnly: `n`,
stateFilterString: "archive",
tagFilter: false,
tagFilterString: "_untagged_",
favouriteFilter: false,
favouriteFilterValue: 0,
searchFilter: false,
searchFilterString: "These 21 things",
domainFilter: false,
domainFilterString: "buzzfeed.com"
}
}
]
};- weeksOfHistory: Number of weeks worth of articles to fetch
- apiMaxRecordsToReturn: Limit the number of records to return, to stop you hitting your api limit.
- getCurrentWeekOnly:
nwill fetch data based on the settings above.yreturns the current week and the last week (it'll make sense when you try it).
- stateFilterString:
unread= only return unread items.archive= only return archived items.all= return both unread and archived items.
- tagFilter:
truewill use thetagFilterStringvalue to get articles with that tag.falsewill ignore thetagFilterStringvalue
- tagFilterString: If
tagFilteris true then get articles tagged with this value.'\_untagged\_'will only return articles with no tags. - favouriteFilter (note UK English spelling!):
truewill use thefavouriteFilterValueto get articles that have/have not been favourited in Pocketfalsewill ignore thefavouriteFilterValue
- favouriteFilterValue:
0= only return un-favorited items1= only return favorited items
- searchFilter:
truewill use thesearchFilterStringvalue to get articles with that value in the URL or title.falsewill ignore thesearchFilterStringvalue
- searchFilterString: If
searchFilteris true then get articles with this value in the URL or title. - domainFilter:
truewill use thedomainFilterStringvalue to get articles for that domain.falsewill ignore thedomainFilterStringvalue
- domainFilterString: If
domainFilteris true then get articles from this domain.
Below is a sample query for fetching all Article nodes.
query PageQuery {
allPocketArticle(sort: { fields: readWeek }) {
edges {
node {
id
url
title
favourite
excerpt
is_article
is_index
has_video
has_image
word_count
tags
time_read
readDay
readWeek
articleDomain
domainFavicon
image {
item_id
src
width
height
}
}
}
}
}
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent