This repository offers a trimmed down starting point for new Canopy IIIF projects. When you need deeper documentation, examples, or release notes, vist the main project at https://canopy-iiif.github.io/app/.
Walk through the Quick Start guide to stand up your new digital project, configure canopy.yml using your preferred IIIF collection, and add pages and layouts under content/.
Keep your project current by running npm install @canopy-iiif/app@latest @samvera/clover-iiif@latest whenever a new release ships, or trigger the Update Canopy App GitHub action (Actions tab → Update Canopy App → Run workflow) and let it open a pull request that bumps both dependencies for you. Read the Developer documentation for more information.
All development happens in https://github.com/canopy-iiif/app. If you are interested in shaping Canopy IIIF, please open an issue, share feedback, or send a pull request.
Canopy IIIF (Canopy) is an open-source project by Mat Jordan, released under the MIT License. Anyone may adapt its features and deploy digital projects without restriction. Canopy follows the principles of the open web: its source code is transparent, and its implementations are static and portable. It runs on any server or service that delivers simple files read directly by web browsers. By working directly with IIIF resources, Canopy keeps materials with the libraries, museums, and archives that serve them, along with their metadata, rights statements, and terms of use. Implementers should be aware of the rights and terms governing the materials they reference, publish, and deploy to the web using Canopy.