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 ToA built-in demonstration ontology that shows how to configure OCG for a vocabulary-oriented GitHub Pages site.
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 InstructionsCustomize the Website
Colors, hero text, featured terms, raw viewer tabs, and custom narrative sections all come from ocg.config.json.
Config SchemaPublish with GitHub Pages
The included workflow rebuilds the site and deploys the generated output directory on every push to main.
Review WorkflowFeatured Terms
Pin important ontology terms in the config so the landing page foregrounds what matters most.
ecv:Capability
A feature or service capability that can be described and published.
ecv:OnlineCapability
A capability that is exposed by an online service endpoint.
ecv:hasRequirement
Links a capability to a requirement.
ecv:DeveloperAudience
Audience profile for client developers integrating the capability.
Examples
Configured example files are surfaced both as cards and optional raw-viewer tabs.
Artifact Viewer
How ToThe raw-viewer tab order is configurable through curation.viewerTabs.
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.