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, PDF documents, MP3s, or links to videos hosted on YouTube or Vimeo
Visit the demo site.
Files to edit
README.md # general readme (this file). Replace it with some kind of short intro to your project for anyone who finds it on GitHub
CITATION.cff # general citation file for automated citation software. Increases your visibility
_config.yml # general site configuration, where you must specify the name of the metadata file you will put in _data
_data/*.csv # various specific site settings, AND where you must put your metadata file
/assets/img # where you want to put images (other than those directly in the collection) that you want to include on the site (like your featured imaged)Continue reading for links to tutorials on how to use this repository below!
Gather your digital objects together and create your metadata using the CollectionBuilder-GH Metadata Template and metadata docs.
Then click the green "use this template" button to create your repository, and add your metadata and configure the repository to fit your collection and settings following the CollectionBuilder Docs.
Please feel free to ask questions in the main CollectionBuilder discussion forum.
Note: Since CollectionBuilder-GH uses GitHub Pages, it is only suitable for small collections, with lower resolution images. GitHub repositories are limited to 1GB. For larger collections or those that require more customization, check out the CollectionBuilder-CSV template.
Follow the CollectionBuilder-GH Walkthrough to set up a collection quickly using demo metadata and objects.
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.
CollectionBuilder-GH aims to be well documented and easy to configure by following the documentation, with the potential to scaffold learning of 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.
Learn about:
- Git and GitHub basics
- Markdown, plaintext writing and content creation
- HTML, CSS, and JavaScript literacy
- command line 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
We prefer commonly understood formats (such as CSV spreadsheets over YAML), and convention over configuration (follow the example over learn all the options).
https://collectionbuilder.github.io/
CollectionBuilder is a project of University of Idaho Library's Digital Initiatives and the Center for Digital Inquiry and Learning (CDIL) following the Lib-Static methodology. 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 theme is created using Bootstrap. Metadata visualizations are built using open source libraries such as DataTables, Leafletjs, Spotlight gallery, lazysizes, and Lunr.js. Object metadata is exposed using Schema.org and Open Graph protocol standards.
Questions can be directed to [email protected]
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.