Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

CollectionBuilder/collectionbuilder-sa

Repository files navigation

CollectionBuilder-SA

Note: the CollectionBuilder-SA template has been depreciated as of 2021-11-04. For new projects please use CollectionBuilder-CSV!

Existing projects using CB-SA will continue to work fine! The code in this repository probably works, but is not actively developed or maintained. Documentation specific to CollectionBuilder-SA has been removed from the main cb-docs site--look in the "docs" folder of this repository for the legacy documentation.


CollectionBuilder-SA ("Stand Alone") is a template for creating digital collection and exhibit websites using Jekyll, given:

  • a CSV of collection metadata
  • a folder of images, PDFs, audio, or video files

Driven by your collection metadata, the template generates engaging visualizations to browse and explore your objects. The resulting static site can be hosted on any basic web server.

CollectionBuilder-SA requires that you generate a thumb and small image derivative/representation for each object in your collection, in additional to the full sized object. This can be automated using the included rake tasks or manually created using other software.

Note: CollectionBuilder-SA collections are scalable to thousands of items, with the only limitation being the final file size of the Lunr static search index. The search page for collections with extensive text metadata and thousands of items will load slowly. Full document text search is possible, but not generally suggested.

CollectionBuilder is an set of open source tools for creating digital collection and exhibit websites that are driven by metadata and powered by modern static web technology. See CB Docs for detailed information.

If you are interested in using CollectionBuilder, or are already using it, please drop us a line ([email protected]) since we would love to learn more about its use in the wild.


CollectionBuilder is a project of University of Idaho Library's Digital Initiatives and the Center for Digital Inquiry and Learning (CDIL) as part of the Lib-STATIC toolkit. Powered by the open source static site generator Jekyll and a modern static web stack, it puts collection metadata to work building beautiful sites.

The basic frame work is created using Bootstrap and jQuery. Metadata visualizations are built using open source libraries such as DataTables, Leafletjs, lightGallery, FontAwesome, lazysizes, and Lunr.js. Object metadata is exposed using Schema.org and Open Graph protocol standards.

Questions can be directed to [email protected]

License

CollectionBuilder documentation and general web content is licensed Creative Commons Attribution-ShareAlike 4.0 International. This license does NOT include any objects or images used in digital collections, which may have individually applied licenses described by a "rights" field. CollectionBuilder code is licensed MIT. This license does not include external dependencies included in the assets/lib directory, which are covered by their individual licenses.