RAMEN SCHEMA

Documentation website for RAMEN — the Reusable Abstraction Model for Editorial Needs.

Overview

RAMEN SCHEMA documents the core concepts of RAMEN and explains how they can be used to model editorial data in digital editions and scholarly editing.

RAMEN provides a conceptual structure for describing content, annotations, entities, collections, and their relations. The documentation is intended for researchers, editors, developers, and Digital Humanities projects that work with structured editorial data.

The site is built with Docusaurus.

Features

• Conceptual documentation for RAMEN
• Markdown/MDX-based documentation content
• Docusaurus-powered static website

Installation

Requirements

• Node.js >=20
• npm

Check your local versions:

node --version
npm --version

Install dependencies:

npm install

Usage

Start the local development server:

npm start

This opens the documentation site in your browser. Most changes to Markdown, React components, and configuration files are reflected automatically while the development server is running.

Configuration

The main configuration files are:

docusaurus.config.ts   # Main Docusaurus configuration
sidebars.ts            # Documentation sidebar configuration

Static assets such as logos and images are stored in:

static/

Documentation content is written in Markdown or MDX inside:

docs/

Development

Clone the repository:

git clone <repository-url>
cd <repository-name>

Install dependencies:

npm install

Start local development:

npm start

Create a production build:

npm run build

Preview the production build locally:

npm run serve

The generated static site is written to:

build/

Project Structure

.
├── docs/                  # Documentation pages
├── src/                   # Custom React components and CSS
├── static/                # Static assets such as logos and images
├── docusaurus.config.ts   # Main Docusaurus configuration
├── sidebars.ts            # Documentation sidebar configuration
├── package.json           # Project scripts and dependencies
└── README.md

License

Documentation content, website text, diagrams, and conceptual explanations in this repository are licensed under the Creative Commons Attribution 4.0 International License.

Machine-readable schema files, source code, configuration files, scripts, and build-related project files are licensed under the Apache License 2.0.

The official RAMEN specification is defined by releases published by the RAMEN project contributors. Forks and adaptations are welcome, but should identify themselves as derived versions unless accepted into an official release.

Maintainers / Contact

RAMEN SCHEMA is maintained by the RAMEN project contributors.

• Sebastian Enns — <sebastian.enns@mni.thm.de>
• Maximilian Michel — <maximilian.michel@adwmainz.de>
• Vincent Neeb — <vincent.neeb@mni.thm.de>
• Andreas Kuczera — <andreas.kuczera@mni.thm.de>