Specifications

Markdown Source of specifications documents

To Debug the Site

bundle install
Run rake dev to compile the site and run a dev server on http://localhost:4000.

To Run the Tests

bundle install
Install grunt npm install -g grunt-cli
Install grunt dependencies npm install
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. 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 for more details about how to join in discussions.