Config-First Ontology Companion

A config-first companion site for your ontology.

Use this repository as a complete example, or add the generator files to an existing ontology repository and point the config at your current source layout. The build regenerates the GitHub Pages companion site around your ontology.

Ontology Snapshot

How To

A built-in demonstration ontology that shows how to configure OCG for a vocabulary-oriented GitHub Pages site.

5
Class
3
Object Property
1
Datatype Property
1
Annotation Property
2
Concept

Repository Workflow

These cards come directly from ocg.config.json and can be replaced with your own onboarding or publication guidance.

Replace the Example Source

Swap the built-in ontology, shapes, examples, and specification with your own files, keeping the same source/ directory structure or updating the config paths.

Read Setup Instructions

Customize the Website

Colors, hero text, featured terms, raw viewer tabs, and custom narrative sections all come from ocg.config.json.

Config Schema

Publish with GitHub Pages

The included workflow rebuilds the site and deploys the generated output directory on every push to main.

Review Workflow

Examples

Configured example files are surfaced both as cards and optional raw-viewer tabs.

Basic Capability Example

Smallest useful graph that exercises the core classes and properties.

Example

Advanced Capability Example

More expressive example showing multiple constraints, labels, and concept references.

Example

Artifact Viewer

How To

The raw-viewer tab order is configurable through curation.viewerTabs.

OWL Ontology
Primary ontology source configured for the site.
View File
Loading...

How This Example Helps

The default files intentionally exercise each major surface of the template so new users can inspect a working ontology, SHACL file, ShEx schema, examples, spec page, graph, reference page, and per-term HTML output before replacing anything.

  • The ontology declares classes, object properties, datatype properties, annotation properties, and SKOS concepts.
  • The examples use the declared terms so the term pages show realistic cross-links.
  • The config demonstrates featured terms, viewer tab selection, custom cards, and footer text.