Git Product home page Git Product logo

bookcase's Introduction

This repository is ⚰️ ARCHIVED ⚰️

I haven't used/worked on this repository in quite some time, thus I'm archiving it.

Feel free to fork and take the project in a new direction. You could also contact me to unarchive it if you are willing to maintain it.


Bookcase

A Jekyll static site to display your books, mixed in with some basic filtering and book metadata. The metadata on each book aids in tracking the location of the book (if it has been borrowed).

How to Use

First you would fork this repository and modify the _books and _config.yml as needed. When using this on Github Pages it is not possible take advantage of some of the _plugins. To work around this, you need to generate the site locally then push the generated files to a gh-pages branch within your forked repository. This can all be accomplished with the rake task rake publish.

Adding and Changing Books

Tag and author pages are automatically generated through Jekyll using the metadata that are attached to the books. The following is a sample of the aforementioned metadata:

---
layout: default
title: 'Practical Object-Oriented Design in Ruby: An Agile Primer'
authors: ['Sandi Metz']
published_date: 2012-09-5
pages: 272
isbn: '978-0321721334'
tags: ['Ruby', 'Object-Oriented Design']

owner: 'Kevin Jalbert'
location: 'Kevin Jalbert'
last_seen: 2015-02-24
---

The authors and tags attributes must follow the indicated format as the author and tag pages are generated from these values (along side the basic filtering). To simplify and hopefully reduce error a rake task (rake sync_resources) is provided which will parse through the _books and reconstruct the necessary information for _data/authors.yml* and _data/tags.yml`.

It is therefore recommended to run rake sync_resources and commit the changes it has made in addition to any book additions/changes made.

Acknowledgments

Jekyll data page generation

bookcase's People

Contributors

kevinjalbert avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

Forkers

nastarovia

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.