Canopy IIIF

An open-source static site generator designed for fast creation, contextualization, and customization of a discovery-focused digital scholarship and collections website using IIIF APIs.

• Demo (Static)
• Demo (Vercel)
• Documentation

Setup

Install Dependencies

# installation
npm i

Running in Development

# development
npm run dev

Building in Production

# build
npm run build

Tests

To run Jest unit tests:

npm run test

Configuration

Canopy IIIF uses a default configuration config/.default/canopy.default.json for demonstration purposes if a custom one is not set. The build process will read from a custom configuration file at config/canopy.json if it exists. See the Create a Canopy Project guide for detailed step-by-step instructions.

License

This project is licensed under the MIT License.