No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
images
test
.gitignore
Makefile
README.md
bookmarklet.ejs
bookmarklet.js
bookmarklet.styl
const.js.styl
constants.js
constants.styl
count.js
host.styl
iframe.js
make.js
match.js
my_readinglist.json
my_resources.yaml
package.json
reading_list.ejs
render.js

README.md

Reading List

A Reading List is a list of Resources plus oprionally a list of Annotations.

Resources

A Resource consists of

  • a title
  • an entry point (absolute URL)
  • a description (in markdown syntax)
  • (optional) a list of pages, where a page
    • can either have a URL or regex that can be used to check whether the browser is currently on that page
    • can be used to show reading progress within a resource

Annotations

An Annotation has

  • one or more regex
  • a title
  • a body (in markdown syntax)
  • (optionally) a CSS selector, selecting the element it will be attachedTo

When the browser is at a url that matches one of the Annotation's regex, it will display title and body on top of the page.