dcalacci / hiboard

hiboard is an open-source reading and highlighting client for articles and content saved on pinboard

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hiboard

hiboard is an article reader and highlighting tool for materials saved on pinboard. It uses readability to render articles, and pdf.js to render PDFs. It supports highlighting and sending text to a server endpoint using JSON.

I made this because I didn't have a good reader that supported both articles and PDFs, and I wanted a way to control where my highlights ended up, and what they looked like. Some tools allow tags, some just freeform notes, but I wanted to be able to choose.

To-Do:

  • support more kinds of annotations in PDFs
  • integrate a server into the app for usability and testing
  • allow editing notes once created
  • helpful keybinds while creating notes and reading
  • figure out why including and renderind pdfs is so fucking hard
  • send highlights and article info to Roam Research
  • figure out how to use pdf.js on mobile

Getting up and running

yarn install
expo start --web

Screenshots and features

Hiboard has a minimal article list after pasting your pinboard API token into the landing page:

article list

Once you click on an article, you enter a nice reading mode:

reading mode

When you make a highlight in an article, you're prompted to add notes. This is just freeform text:

highlighting

You can also read and make highlights in PDFs you've saved to pinboard:

pdfs

Dev Notes

in pdfjs-dist, you need to replace the optionalContentConfig line with null (better description here in the future).

About

hiboard is an open-source reading and highlighting client for articles and content saved on pinboard


Languages

Language:JavaScript 84.0%Language:CSS 16.0%