work in progress!
A project to generate a free and simple digital collection site using GitHub Pages given:
- a CSV of collection metadata
- a folder of JPEG images or PDF documents
See Getting Started Docs for detailed information.
collectionbuilder-gh is intended as a simple template for hands-on teaching about digital libraries.
It can be used in a workshop setting to take participants through digitization and metadata creation, to having a live collection site hosted on GitHub.
Similar learning experiences use Omeka or other DAMS/CMS platforms that are overkill for one off projects. Although CMS feature familiar GUI administration interfaces, they are not simple to learn and customize. These experiences must focus on teaching the specific tool rather than general web skills and the heavy infrastructure is a barrier to adoption and further development.
collectionbuilder-gh aims to be well documented and easy to configure by following the example, with the potential to scaffold to learn a multitude of transferable digital and data skills.
A project in "minimal computing", it provides a depth of learning opportunities, allowing users to take complete ownership over the project and make their work open to the world.
- Git and GitHub basics
- Markdown, plaintext writing and content creation
- HTML, CSS, and JS literacy
- commandline literacy
- GitHub collaboration and project management
- Jekyll basics
- working in the Open, open source and open data
- digital libraries concepts such as "collections as data", minimal computing, data-driven design
collectionbuilder-gh uses GitHub Pages, it is only suitable for small collections, with lower resolution images.
GitHub repositories are limited to 1GB.
We prefer commonly understood formats (such as CSV spreadsheets over YAML), and convention over configuration (follow the example over learn all the options).
- Jekyll for GitHub Pages
- Layout using Bootstrap.
- Mapping using Leaflet.js
- Tables using DataTables
- Galleries using lightGallery
- Simple lunr search
- Rich markup using Schema.org and Open Graph protocol standards.
Build a Digital Collection!
If you are interested in using CollectionBuilder, or are already using it, please drop us a line (email@example.com) since we would love to learn more about it's use in the wild. There are also currently opportunities to collaborate on CollectionBuilder.
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.