0.02
There's a lot of open issues
A Jekyll plugin to load components from bookshop
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

~> 0.80

Runtime

>= 3.7, < 5.0
>= 0.1, < 1.0
 Project Readme

Bookshop

Integration Test Status Javascript Test Status Ruby Test Status

Bookshop is a component development workflow for static websites. Bookshop currently supports Jekyll and Eleventy, with Hugo support coming in the near future.

Iconography representing some components that might reside in a component library. There are lines connecting some of the components to wireframed areas of two example website pages.

Concepts

Bookshop defines a convention for building self-contained components in the templating languages supported by common static site generators. Using these conventions, Bookshop provides developer tooling that empowers you to integrate these components with your stack, build and browse UI components locally, and provide rich live editing experiences for your editors.

A good rundown of our motivations and the problems we are looking to solve can be found in our launch post on CloudCannon.

Quick start

To jump right into using Bookshop on a site, check out the Jekyll Bookshop Starter or Eleventy Bookshop Starter. Then read through the guides below to get a feel for how everything plugs together.

Guides

Conventions Guide

Learn the Bookshop conventions, from how to write Bookshop TOML files to the component file structure.

Jekyll Guide

How to integrate your Bookshop project into a Jekyll website.

Eleventy Guide

How to integrate your Bookshop projects into an Eleventy website.

Browser Guide

How to setup and use the Bookshop component browser locally and on a hosted URL.

Live Editing Guide

Information on how the experimental live editing works, and how to configure it.