Guides

The Guides section collects useful articles, tutorials and examples for Annotorious and RecogitoJS. If you want to learn about a specific topic that isn’t covered yet, please get in touch via the Gitter chat.

If you want to improve anything about a guide - or contribute a new one - please do so! Fork this site and send a pull request with your corrections or additions. The guides are located here in the repository.

Configuring the Editor

This guide explains how you can configure the widgets that appear in the editor, and how you can pass additional configuration options to specific widgets. Read more

Customizing Styles

This guide explains how you can customize the visual appearance of Annotorious with CSS. Read more

Headless Mode

A Guide to Headless Mode, which allows you to use Annotorious without the editor popup. Read more

Firebase Storage Plugin

In order to store annotations, you need a server backend that is able to handle W3C Web Annotations. This guide provides a simple recipe for using Firebase, an online cloud storage service by Google, as your personal annotation server. Read more

Writing Editor Widgets

This guide explains how you can write your own widgets and plug them into the annotation editor. Read more

React Editor Widget

This guide re-implements the example widget from the previous guide in React. Read more

Contributing Translations

We want to make the user interface available in as many languages as possible. If you want to help: contributing a translation is easy. This guide explains how. Read more

Hacker's Guide

We welcome contributions! Both to our code as well as our documentation. This guide explains how to set up your development environment for hacking Annotorious or RecogitoJS. Read more