Annotation Editor
Monorepo for W3C-compliant annotation editing. Provides a NestJS API module for serving annotation definitions, a shared core library for types and validation, and a Vue 3 editor component for creating and managing annotations on text sources.
Documentation: https://ghentcdh.github.io/annotation-editor/
Packages
| Package | Description |
|---|---|
@ghentcdh/annotation-core |
Shared types, Zod schemas, and configuration utilities |
@ghentcdh/annotation-vue |
Vue 3 annotation editor and preview components (bundled, ready to use) |
@ghentcdh/annotation-api |
NestJS module for serving annotation definitions |
Status: release candidate (0.1.0-rc). The public API is frozen until 0.1.0; only bug fixes land in RCs. Prereleases publish under the npm dist-tags
rc/alpha(npm i @ghentcdh/annotation-vue@rc). Coming from0.0.1-alpha.x? See the migration notes for the annotation transformer and resourcenameas id.
Getting started
See the documentation for installation, configuration, and usage guides.
Architecture
┌─────────────────────┐
│ annotation-vue │ Vue 3 editor + preview components
│ (frontend) │
└────────┬────────────┘
│ uses types from
┌────────▼────────────┐
│ annotation-core │ Shared types, Zod schemas, config
└────────┬────────────┘
│ used by
┌────────▼────────────┐
│ annotation-api │ NestJS module (serves definitions)
│ (backend) │
└─────────────────────┘
- annotation-core — shared dependency used by both frontend and backend
- annotation-api — loads annotation definitions from JSON files and serves them via REST
- annotation-vue — renders sources and annotations, provides CRUD UI using the W3C annotation standard via
@ghentcdh/w3c-utils
Development
# Install dependencies
pnpm install
# Lint
pnpm nx affected -t lint --base=origin/main
# Test
pnpm nx affected -t test --base=origin/main
# Type check
pnpm nx affected -t typecheck --base=origin/main
Releasing
pnpm release prerelease --preid rc # next release candidate (0.1.0-rc.N)
pnpm release 0.1.0 # final release
The script bumps the versions, updates RELEASE_NOTES.md, tags v<version> and pushes; the tag triggers the
Publish workflow, which publishes to npm (rc/alpha dist-tag for prereleases, latest otherwise) and
creates the GitHub release. Only the ghentcdh-developers team can push release tags. Details, dry run and
undo: CONTRIBUTING.md.
License
MIT — see LICENSE.
Credits
Bo Vandersteene, Ghent University.
Development by Ghent Centre for Digital Humanities — Ghent University. Funded by the GhentCDH research projects.