biiif-workshop

April 15, 2019 · View on GitHub

Note: Please also see https://github.com/edsilv/code-of-ethics-zine-workshop for a more detailed example of how to make a zine with biiif.

Learn how to use biiif to generate IIIF data from static files and host it on github pages.

Setup

Ensure you have git and nodejs installed.

Create a github repo named 'biiif-workshop'.

From here onwards, [username] should be replaced with your github username.

Clone your repo and cd into it. Now run:

git checkout -b gh-pages
npm init -y
npx biiif collection -u https://[username].github.io/biiif-workshop/collection -s

Add this to your package.json:

"scripts": {
    "build": "npx biiif collection -u https://[username].github.io/biiif-workshop/collection -g"
}

mkdir collection/_cat

Add a cat pic to the /collection/_cat folder

npm run build
git add -A
git commit -m "added cat pic"
git push origin gh-pages

Open https://[username].github.io/biiif-workshop/collection/index.json on http://universalviewer.io/examples

Create /collection/_cat/info.yml containing:

label: Cat
description: A picture of a cat

npm run build
git add -A
git commit -m "added description"
git push origin gh-pages

Open https://[username].github.io/biiif-workshop/collection/index.json on http://universalviewer.io/examples

Open the 'more information' panel on the right hand side to see the descriptive metadata.

See the contents of this repository for a more complete example (a book about cats!)