Giter VIP home page Giter VIP logo

api's Introduction

Stories in Ready Build Status

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.

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. Links internal and external should be in the following forms:
    • Internal relative link inside the API website [hyperlink text]({{ site.url }}{{ site.baseurl }}/end/point)
    • link from the API website to the main website (not relative to this repo) [hyperlink text]({{ page.webprefix }}/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.

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.

api's People

Contributors

acdha avatar aeschylus avatar ahankinson avatar andyc-cogapp avatar azaroth42 avatar barnaclebarnes avatar blalbrit avatar bvibber avatar dsblank avatar edsilv avatar edsu avatar eefahy avatar glenrobson avatar jchristo4 avatar jronallo avatar julsraemy avatar kinow avatar knagasaki avatar mejackreed avatar mikeapp avatar regisrob avatar rsinghal avatar schwemmer avatar srabun avatar tomcramer avatar tomcrane avatar waffle-iron avatar zimeon avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.