Apache Annotator (incubating) ![Build Status](https://camo.githubusercontent.com/8d5b0c76e9d5117e11440371bb6ccf69dd1ccf6ea556f8285c6f4593ac957b95/68747470733a2f2f7472617669732d63692e6f72672f6170616368652f696e63756261746f722d616e6e6f7461746f722e7376673f6272616e63683d6d6173746572)
Apache Annotator provides annotation enabling code for browsers, servers, and humans.
Usage
We're currently pre-releasing development copies of each library that makes up the sum total of Apache Annotator's code. You can grab any of them from our npm organization.
$ # for example...
$ npm install --save @annotator/dom
Requirements
Development
Requirements
We use Lerna to juggle the various Apache Annotator libraries. If you'd like to contribute, you'll need the following:
Setup
$ yarn install
Test
$ yarn test
Run localhost demo server
$ yarn start
Once the test server has started, you can browse a local demo, and run tests in
a browser by visiting http://localhost:8080/
.
Web Annotation Data Model Validation
If you have any Web Annotation Data Model JSON documents, you can validate them
using the validate
script:
$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
With the --url
option you can pass in a URL or a local path to a JSON file.
Examples
Valid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json
Invalid:
https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/incorrect/anno1.json
License
Apache License 2.0