https://github.com/IIIF/api

Source for API and model specifications documents (api and model)
https://github.com/IIIF/api

api-documentation api-spec api-specs iiif iiif-annotations iiif-auth iiif-av iiif-image iiif-presentation iiif-presentation-3 iiif-search

Last synced: about 1 month ago
JSON representation

Source for API and model specifications documents (api and model)

• Host: GitHub
• URL: https://github.com/IIIF/api
• Owner: IIIF
• Created: 2014-02-21T13:18:59.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-24T16:01:12.000Z (about 2 months ago)
• Last Synced: 2024-10-25T09:05:44.475Z (about 2 months ago)
• Topics: api-documentation, api-spec, api-specs, iiif, iiif-annotations, iiif-auth, iiif-av, iiif-image, iiif-presentation, iiif-presentation-3, iiif-search
• Language: HTML
• Homepage: http://iiif.io/api
• Size: 29.6 MB
• Stars: 107
• Watchers: 36
• Forks: 54
• Open Issues: 148
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

• awesome-starred - IIIF/api - Source for API and model specifications documents (api and model) (others)

README

        
[![Build Status](https://travis-ci.org/IIIF/api.svg?branch=master)](https://travis-ci.org/IIIF/api)

# Specifications

Markdown Source of specifications documents

## To Debug the Site

 1. `bundle install`

 2. Run `rake dev` to compile the site and run a dev server on [http://localhost:4000](http://localhost:4000).

## To Run the Tests

 1. `bundle install`

 2. Install grunt `npm install -g grunt-cli`

 3. Install grunt dependencies `npm install`

 4. Run `rake ci`

## To Publish the Site to iiif.io

Branches are available at http://preview.iiif.io/api/[branch_name]/api/index.html. The master branch is automatically loaded to the iiif.io website.

## Some Things to Note

 * Much of the site data is in the YAML files in `_data/` (e.g. member institutions, server impls, demos, etc.) make edits there.

 * The latest versions of the APIs are set in `_config.yml`. Change there will get pushed to `.htaccess`, `technical-details/`, and any other links.

 * The website is now split with the specification website living here and the main website living in [IIIF/website](https://github.com/IIIF/website). Links internal and external should be in the following forms:

    * Internal relative link inside the API website `[hyperlink text]({{ site.api_url }}/end/point)`

    * link from the API website to the main website (not relative to this repo) `[hyperlink text]({{ site.root_url }}/end/point)`

    * External link `[anchor-text](http://example.com/end/point)`

    * Reference link `[text][link_name]` where link_name is expanded at the bottom of the page.

 * If this branch has a domain name associated with it e.g. prezi3.iiif.io then add the name of the branch to the `ROOT_BRANCHES` variable in the `.travis.yml`. Note branch names are sperated by a space.    

## Contributions

Participation in the IIIF community is welcome in all forms, from any individual or organization. Please see the [community page](http://iiif.io/community/) for more details about how to join in discussions.

Contributions to the text of the specifications and the content of the website are welcome in the form of pull requests, or by comments with proposed text on issues.   By making such a contribution, the contributor asserts that they have the right to license the contribution such that content may be published under the CC-BY license by the IIIF Consortium, per the license statement on all documents.