README.md

Mirador with support for displaying annotations on videos

Project

https://dh.l.u-tokyo.ac.jp/activity/iiif/video-annotation

Demo

• https://dzkimgs.l.u-tokyo.ac.jp/videos/m3/cat_video.html
• https://dzkimgs.l.u-tokyo.ac.jp/videos/m3/video.html

Manifest Sample

• https://dzkimgs.l.u-tokyo.ac.jp/videos/cat2020/manifest.json
• https://dzkimgs.l.u-tokyo.ac.jp/videos/iiif_in_japan_2017/manifest.json

Prebuilt

https://dzkimgs.l.u-tokyo.ac.jp/videos/m3/mirador.min.js

License

This project is dual-licensed under the Apache License 2.0 and the MIT license. See LICENSE for details.

---

⚠️ This project is for Mirador 3, the latest version of Mirador. For Mirador 2, please see ProjectMirador/mirador2 or legacy documentation on the Mirador 2 wiki. Please note that the community's focus is on Mirador 3, and are unlikely to accept pull requests or provide support for Mirador 2.

Mirador

For Mirador Users

You can quickly use and configure Mirador by remixing the mirador-start Glitch.

We recommend installing Mirador using a JavaScript package manager like npm or yarn.

$ npm install mirador 

# or

$ yarn add mirador

If you are interested in integrating Mirador with plugins into your project, we recommend using webpack or parcel to integrate the es version of the packages. Examples are here:

https://github.com/ProjectMirador/mirador-integration

If you want to simply embed Mirador in an HTML page without further customization, include the Mirador UMD build:

<script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>

More examples of embedding Mirador can be found at https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Adding translations to Mirador

For help with adding a translation, see src/locales/README.md

Running Mirador locally for development

Mirador local development requires nodejs to be installed.

1. Run npm install to install the dependencies.

Starting the project