CloudCannon / bookshop

📚 A component development workflow for static websites.
MIT License
249 stars 21 forks source link

= Bookshop ifdef::env-github[] :tip-caption: :bulb: :note-caption: :information_source: :important-caption: :heavy_exclamation_mark: :caution-caption: :fire: :warning-caption: :warning: endif::[] :version: 3.12.0

https://github.com/CloudCannon/bookshop/actions/workflows/integration-test.yml[image:https://github.com/CloudCannon/bookshop/actions/workflows/integration-test.yml/badge.svg?branch=main&event=push[Integration Test Status]] https://github.com/CloudCannon/bookshop/actions/workflows/test-node.yml[image:https://github.com/CloudCannon/bookshop/actions/workflows/test-node.yml/badge.svg?branch=main&event=push[Javascript Test Status]] https://github.com/CloudCannon/bookshop/actions/workflows/test-ruby.yml[image:https://github.com/CloudCannon/bookshop/actions/workflows/test-ruby.yml/badge.svg?branch=main&event=push[Ruby Test Status]]

https://github.com/cloudcannon/bookshop/releases/[image:https://img.shields.io/static/v1?label=version&message={version}&style=flat&color=informational[Version {version}]] image:https://img.shields.io/github/release-date/cloudcannon/bookshop?color=informational[GitHub Release Date]

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

image::bookshop-hero.png[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 link:https://cloudcannon.com/blog/introducing-bookshop/[launch post on CloudCannon].

== Quick start To get started, head over to the guide for the SSG you would like to work with.