epsil / readinglist

Reading list

Home Page:https://epsil.github.io/leseliste/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Reading list

A markdown-it template for writing reading lists in Markdown.

Description

Book entries are linkified with references to the local Calibre library, as well as Amazon.com, Goodreads, LibraryThing, WorldCat, Google Books, Reddit, Hacker News, Stack Exchange, Medium and Wikipedia.

Furthermore, #hashtags may be used to group books into sub-lists.

Usage

Edit list.txt in a text editor and add or remove book entries.

Open index.html to view the result.

Example

Reading list in Markdown:

- Matthew MacDonald: *HTML5: The Missing Manual* #development
- ~~Erich Gamma & Richard Helm & Ralph Johnson & John Vlissides: *Design Patterns*~~ #development
- Steve Krug: *Don't Make Me Think!* #design
- Garr Reynolds: *Presentation Zen* #presentation

How it is rendered as HTML:

Screencast

Configuration

Calibre's web server should be configured to run on port 8080 (see the options $.fn.readingList.defaults.calibreHost and $.fn.readingList.defaults.calibrePort in readinglist.js).

HTTP server

The code uses markdown-template to read the contents of list.txt. Locally, this works very well in Firefox. Chrome, however, imposes restrictions on local file access. A workaround is to host the files on a local HTTP server, for example http-server:

$ npm install -g http-server
$ http-server -a localhost -p 80

Run these commands in the directory containing index.html and list.txt. The reading list is now available from http://localhost/.

To do

The Markdown conversion is performed on-the-fly in the browser, and the links are added with a bit of jQuery in custom.js. It might be faster to preprocess the HTML document with jsdom.

License

License

Released under the MIT License. See the LICENSE file for details.

Alternatives

Websites:

Apps:

Calibre plugins:

About

Reading list

https://epsil.github.io/leseliste/

License:MIT License


Languages

Language:JavaScript 98.8%Language:CSS 0.9%Language:HTML 0.3%