generated from CollectionBuilder/collectionbuilder-csv
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b651456
commit 1224d2e
Showing
1 changed file
with
14 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,33 @@ | ||
| # CollectionBuilder-CSV | ||
| # CollectionBuilder Examples | ||
|
|
||
| CollectionBuilder-CSV is a robust and flexible "stand alone" template for creating digital collection and exhibit websites using Jekyll and a metadata CSV. | ||
| 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 (or built automatically using GitHub Actions). | ||
| This repository hosts the CollectionBuilder Examples site: [https://collectionbuilder.github.io/cb-examples/](https://collectionbuilder.github.io/cb-examples/){:target="_blank" rel="noopener"}. Visit the [CollectionBuilder Docs](https://collectionbuilder.github.io/cb-docs/){:target="_blank" rel="noopener"} for step-by-step details for getting started with building digital collections. | ||
|
|
||
| Visit the [CollectionBuilder Docs](https://collectionbuilder.github.io/cb-docs/) for step-by-step details for getting started and building collections! | ||
| ## About this Collection | ||
|
|
||
| ## Brief Overview of Building a Collection | ||
| This collection of CollectionBuilder projects features sites created by a variety of individuals, organizations, and institutions. These examples are meant to demonstrate numerous possibilities and use cases for CollectionBuilder. This collection is based off our [Zotero library of CollectionBuilder examples](https://www.zotero.org/groups/5020353/collectionbuilder-examples/library){:target="_blank" rel="noopener"}. | ||
|
|
||
| The [CollectionBuilder Docs](https://collectionbuilder.github.io/cb-docs/) contain detailed information about building a collection from start to finish--including installing software, using Git/GitHub, preparing digital objects, and formatting metadata. | ||
| However, here is a super quick overview of the process: | ||
| ### Add Your Project | ||
|
|
||
| - Make your own copy of this template repository by clicking the green "Use this Template" button on GitHub (see [repository set up docs](https://collectionbuilder.github.io/cb-docs/docs/repository/)). This copy of the template is the starting point for your "project repository", i.e. the source code for your digital collection site! | ||
| - Prepare your collection metadata following the CB-CSV template (see our demo [metadata template on Google Sheets](https://docs.google.com/spreadsheets/d/1nN_k4JQB4LJraIzns7WcM3OXK-xxGMQhW1shMssflNM/edit?usp=sharing) and [metadata docs](https://collectionbuilder.github.io/cb-docs/docs/metadata/csv_metadata/)). Your metadata will include links to your digital files (images, pdfs, videos, etc) and thumbnails wherever they are hosted. | ||
| - Add your metadata as a CSV to your project repository's "_data" folder (see [upload metadata docs](https://collectionbuilder.github.io/cb-docs/docs/metadata/uploading/)). | ||
| - Edit your project's "_config.yml" with your collection information (see [site configuration docs](https://collectionbuilder.github.io/cb-docs/docs/config/)). Additional customization is done via a theme file, configuration files, CSS tweaks, and more--however, once your "_config.yml" is edited your site is ready to be previewed. | ||
| - Generate your site using Jekyll! (see docs for how to [use Jekyll locally](https://collectionbuilder.github.io/cb-docs/docs/repository/generate/) and [deploy on the web](https://collectionbuilder.github.io/cb-docs/docs/deploy/)) | ||
|
|
||
| Please feel free to ask questions in the main [CollectionBuilder discussion forum](https://github.com/CollectionBuilder/collectionbuilder.github.io/discussions). | ||
| Do you have a CollectionBuilder project to be featured in this collection? We encourage anyone who is interested in adding their digital collection to the site to fill out this [Google Form](https://forms.gle/k1fsqiRPo71uULfo8){:target="_blank" rel="noopener"}. | ||
|
|
||
| ---------- | ||
|
|
||
| ## CollectionBuilder | ||
|
|
||
| <https://collectionbuilder.github.io/> | ||
|
|
||
| CollectionBuilder is a project of University of Idaho Library's [Digital Initiatives](https://www.lib.uidaho.edu/digital/) and the [Center for Digital Inquiry and Learning](https://cdil.lib.uidaho.edu) (CDIL) following the [Lib-Static](https://lib-static.github.io/) methodology. | ||
| Powered by the open source static site generator [Jekyll](https://jekyllrb.com/) and a modern static web stack, it puts collection metadata to work building beautiful sites. | ||
| CollectionBuilder is a project of University of Idaho Library's [Digital Initiatives](https://www.lib.uidaho.edu/digital/){:target="_blank" rel="noopener"} and the [Center for Digital Inquiry and Learning](https://cdil.lib.uidaho.edu){:target="_blank" rel="noopener"} (CDIL) following the [Lib-Static](https://lib-static.github.io/){:target="_blank" rel="noopener"} methodology. | ||
| Powered by the open source static site generator [Jekyll](https://jekyllrb.com/){:target="_blank" rel="noopener"} and a modern static web stack, it puts collection metadata to work building beautiful sites. | ||
|
|
||
| The basic theme is created using [Bootstrap](https://getbootstrap.com/). | ||
| Metadata visualizations are built using open source libraries such as [DataTables](https://datatables.net/), [Leafletjs](http://leafletjs.com/), [Spotlight gallery](https://github.com/nextapps-de/spotlight), [lazysizes](https://github.com/aFarkas/lazysizes), and [Lunr.js](https://lunrjs.com/). | ||
| Object metadata is exposed using [Schema.org](http://schema.org) and [Open Graph protocol](http://ogp.me/) standards. | ||
| The basic theme is created using [Bootstrap](https://getbootstrap.com/){:target="_blank" rel="noopener"}. | ||
| Metadata visualizations are built using open source libraries such as [DataTables](https://datatables.net/), [Leafletjs](http://leafletjs.com/), [Spotlight gallery](https://github.com/nextapps-de/spotlight){:target="_blank" rel="noopener"}, [lazysizes](https://github.com/aFarkas/lazysizes){:target="_blank" rel="noopener"}, and [Lunr.js](https://lunrjs.com/){:target="_blank" rel="noopener"}. | ||
| Object metadata is exposed using [Schema.org](http://schema.org){:target="_blank" rel="noopener"} and [Open Graph protocol](http://ogp.me/){:target="_blank" rel="noopener"} standards. | ||
|
|
||
| Questions can be directed to **[email protected]** | ||
| Questions can be sent to the CollectionBuilder team at **[email protected]** or posted in the main [CollectionBuilder discussion forum](https://github.com/CollectionBuilder/collectionbuilder.github.io/discussions){:target="_blank" rel="noopener"}. | ||
|
|
||
| ## License | ||
|
|
||
| CollectionBuilder documentation and general web content is licensed [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/). | ||
| CollectionBuilder documentation and general web content is licensed [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/){:target="_blank" rel="noopener"}. | ||
| 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](https://github.com/CollectionBuilder/collectionbuilder-csv/blob/master/LICENSE). | ||
| CollectionBuilder code is licensed [MIT](https://github.com/CollectionBuilder/collectionbuilder-csv/blob/master/LICENSE){:target="_blank" rel="noopener"}. | ||
| This license does not include external dependencies included in the `assets/lib` directory, which are covered by their individual licenses. |