This GitHub action bookmarks websites to a JSON file. Pair it with the iOS Shortcut or click Run workflow from the Actions tab to submit details for the bookmark.
Create a workflow dispatch event with basic information about the bookmark. The action will then fetch the web page's metadata using open-graph-scraper and add it to your JSON file in your repository, always sorting by the bookmark date.
To use this action, create a new workflow in .github/workflows
and modify it as needed:
name: Add bookmark
run-name: Add bookmark (${{ inputs.url }})
on:
workflow_dispatch:
inputs:
url:
description: The URL to bookmark.
required: true
type: string
notes:
description: Notes about the bookmark.
type: string
date:
description: Date (YYYY-MM-DD). The default date is today.
type: string
tags:
description: Add tags to categorize the book. Separate each tag with a comma. Optional.
type: string
permissions:
contents: write
jobs:
add-bookmark:
runs-on: ubuntu-latest
name: Add bookmark
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Bookmark action
uses: library-pals/bookmark-action@v7.0.1
with:
filename: _data/recipes.json
- name: Download the thumbnail image
run: curl "${{ env.BookmarkImage }}" -o "img/${{ env.BookmarkImageOutput }}"
if: env.BookmarkImage != ''
- name: Commit files
run: |
git pull
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add -A && git commit -m "Bookmark ${{ env.BookmarkTitle }}"
git push
Add bookmark with additional properties
name: Add bookmark with additional properties
run-name: Add bookmark (${{ inputs.url }})
on:
workflow_dispatch:
inputs:
url:
description: The URL to bookmark.
required: true
type: string
notes:
description: Notes about the bookmark.
type: string
date:
description: Date (YYYY-MM-DD). The default date is today.
type: string
tags:
description: Add tags to categorize the bookmark. Separate each tag with a comma. Optional.
type: string
# The following property names are defined by the task input "additional-properties"
rating:
description: Rate the bookmark from 1 to 5. Optional.
type: string
quote:
description: Add a quote from the bookmark. Optional.
type: string
permissions:
contents: write
jobs:
add-bookmark:
runs-on: ubuntu-latest
name: Add bookmark
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Bookmark action
uses: library-pals/bookmark-action@v7.0.1
with:
filename: _data/recipes.json
# You can define additional properties you want to pass through
additional-properties: rating,quote
- name: Download the thumbnail image
run: curl "${{ env.BookmarkImage }}" -o "img/${{ env.BookmarkImageOutput }}"
if: env.BookmarkImage != ''
- name: Commit files
run: |
git pull
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"
git add -A && git commit -m "Bookmark ${{ env.BookmarkTitle }}"
git push
-
filename
: The filename to save your bookmarks. Default:_data/bookmarks.json
. -
export-image
: Export the URL'simage
to download later and setimage
property. Default:true
. -
additional-properties
: Additional properties to add to the bookmark from the workflow payload formatted as a comma delimited string.
To trigger the action, create a workflow dispatch event with the following body parameters:
{
"ref": "main", // Required. The git reference for the workflow, a branch or tag name.
"inputs": {
"url": "", // Required. The URL to bookmark.
"notes": "", // Notes about the bookmark.
"date": "", // Date (YYYY-MM-DD). The default date is today.
"tags": "", // Add tags to categorize the book. Separate each tag with a comma. Optional.
}
}