IIIF/api

Overview

GitHubGitHub

IIIF/api is the Markdown source repository for the IIIF (International Image Interoperability Framework) API and model specification documents. This repository stores, builds, and publishes various IIIF technical specifications, including the Presentation API, Image API, Authentication API, Search API, AV API, and Annotations. ## What It Is This is the source code repository for a technical documentation site serving the IIIF community, using Jekyll for static site generation. Specification texts are written in Markdown, while structured site data (such as member institutions, server implementations, and demos) is stored in YAML files under the `_data/` directory. The latest API version information is configured in `_config.yml`. ## What Problem It Solves It provides a standardized workflow for maintaining, reviewing, and publishing IIIF specifications. Contributors can submit proposed changes to specification texts via Pull Requests or Issues. Every branch is automatically deployed to `preview.iiif.io` for previewing, and content on the master branch is automatically published to the official iiif.io website. ## Key Capabilities - **Local Development**: After installing dependencies with `bundle install`, run `rake dev` to start a local development server at `http://localhost:4000`. - **Automated Testing**: Run CI test workflows (`rake ci`) using Rake, Grunt, and npm. - **Branch Previews**: All branches can be accessed via specific URLs for preview versions. - **Content Separation**: The specification site and the main IIIF site reside in separate repositories, with internal links managed using Liquid template variables. ## Who It's For Ideal for developers and researchers involved in shaping IIIF specifications, as well as software engineers who need to consult or reference IIIF API technical details. All individuals and organizations are welcome to participate in discussions and contribute to the IIIF community.

Q&A

How do I run this specification site locally?AI-generated

First, run bundle install to install dependencies, then run rake dev to start the local development server at http://localhost:4000.

How do I run the project's tests?AI-generated

Run bundle install, npm install -g grunt-cli, and npm install in sequence to install dependencies, then run rake ci.

How can I contribute to the IIIF specifications?AI-generated

You can submit a Pull Request or suggest text changes by commenting in an Issue. Contributions are published by the IIIF Consortium under the CC BY license.

What is the relationship between the specification site and the main IIIF site?AI-generated

They have been split into separate repositories. The specification site source is in this repository, while the main site source is in the IIIF/website repository. Cross-site links must use the site.root_url variable.