Skip to content
A static site generator for your reading list.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rubocop.yml
.rubocop_todo.yml
.ruby-version
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
reading_list.gemspec

README.md

reading_list

A static site generator for your reading list.

Installation

$ gem install reading_list

Usage

To generate your reading list website, you'll need two files: a YAML config file and a JSON book file.

The Config file

The basic structure of the config file looks like this:

name: YOUR_NAME
email: YOUR_EMAIL

book_file: PATH_TO_BOOK_FILE

output:
  dir: OUTPUT_DIRECTORY
  theme: default
Key Value
name Your name. Displayed in the header of the generated site.
email (Currently unused) Your email address.
website (Currently unused) Your website.
book_file The relative path to your book file.
output/dir The relative path to the output directory. The generated HTML and CSS files will be written there. Caution: Any existing HTML and CSS output will be overwritten.
output/theme The name of the theme for your site. The only supported value (at least for now) is default.

All of the values are required.

The Book file

The book file is a JSON file containing an array of JSON objects. The structure looks like this:

[
  {
    "title": "The Lion, the Witch, and the Wardrobe",
    "author": "C. S. Lewis",
    "year": 2017,
    "link": "https://www.amazon.com/Lion-Witch-Wardrobe-Chronicles-Narnia/dp/0064404994/"
  },

  {
    // etc
  }
]
Key Type Value
title string The title of the book
author string The author of the book
year int The year you read the book (not the year it was published)
link string (Optional) A link to the book's website or Amazon page. If provided, the book's title will be a link to this URL in the output.

Running the generator

To generate your site, run the following command, passing in the relative path to your config file:

reading_list -c [CONFIG_FILE]

Run reading_list -h for help.

Sample output

See reading.joshtompkins.com for a sample site running the default theme.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/jtompkins/reading_list.

You can’t perform that action at this time.