wgroeneveld
/
jam-my-stack
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
A set of simple IndieWeb Jamstack publishing syndication tools
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9 Commits
1 Branch
0 Tags
12 MiB
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fcb8a6d2b0'
${ noResults }
Go to file
Wouter Groeneveld fcb8a6d2b0
Create main.yml 		2 years ago
.github/workflows Create main.yml 2 years ago
.yarn move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
src added readme 2 years ago
test move mock tests to separate file 2 years ago
.gitignore move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
.pnp.js move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
.yarnrc.yml move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
README.md added version badge 2 years ago
jam-my-stack.sublime-project move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
package-lock.json move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
package.json move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago
yarn.lock move masto-feed-parser out of brainbaking repo, first jest tests 2 years ago

README.md

jam-my-stack 🥞

A set of simple IndieWeb Jamstack publishing syndication tools

Published at https://www.npmjs.com/package/jam-my-stack

npm version

These simple scripts enrich your Jamstack-site by adding/manipulating/whatever (meta)data, such as extra posts, indexing, and so forth. A primary example of these tools in action is my own site https://brainbaking.com - inspect how it's used at https://github.com/wgroeneveld/brainbaking

The tools

Usage:

  1. yarn add jam-my-stack
  2. const { mastodon, goodreads, lunr } = require('jam-my-stack')

1. Mastodon

1.1 parseFeed

An async function that parses your Fediverse-compatible feed (Mastodon/Pleroma/...) and converts entries to .md Markdown files for your Jamstack to enjoy.

Usage example:

    await mastodon.parseFeed({
        notesdir: `${__dirname}/content/notes`,
        url: "https://chat.brainbaking.com/users/wouter/feed"
    })

2. Goodreads

2.1 createWidget

An async function that reads and modifies Goodreads JS widget embed code, converting low-res book covers to hi-res ones if possible. This omits possible Goodread cookies and cross-domain mishaps.

Usage example:

    const widget = await goodreads.createWidget("https://www.goodreads.com/review/grid_widget/5451893.Wouter's%20bookshelf:%20read?cover_size=medium&hide_link=&hide_title=&num_books=12&order=d&shelf=read&sort=date_added&widget_id=1496758344")
    await fsp.writeFile(`${__dirname}/static/js/goodreads.js`, widget, 'utf-8')

3. Lunr

3.1 buildIndex

An async function that reads all .md files of certain locations (pass as an array []), generating a Lunr.js .json index object. Serialize it yourself wherever you'd like it to go.

Usage example:

    const index = await lunr.buildIndex([
        `${__dirname}/content/post`,
        `${__dirname}/content/notes`])
    await fsp.writeFile(`${__dirname}/static/js/brainbaking-post.json`, JSON.stringify(index), 'utf-8')