ontoink¶

Turn RDF/Turtle into interactive, publication-ready ontology diagrams — with SHACL constraint visualization and live editing — right inside MkDocs.

Try Playground Get Started

pip install ontoink

Why ontoink?¶

Ontology documentation should be visual, interactive, and verifiable. ontoink embeds live ontology diagrams directly into your MkDocs site — no screenshots, no external tools, no manual drawing.

Interactive Graphs¶

Pan, zoom, drag, search, switch layouts (dagre, force, circle, tree). Click any node or edge for details with IRI dereferencing.

Automatic Label Resolution¶

Fetches human-readable labels from referenced ontologies (nfdicore, BFO, IAO, FOAF, etc.) — see "contributor role" instead of NFDI_0000118 in popups, SPARQL autocomplete, and query results.

SHACL Validation¶

Constraints overlaid with cardinality badges. Visual coverage map. SHACL Editor for building shapes without code.

OWL Reasoning¶

HermiT reasoner infers subclass chains, inverse properties, transitive closures. Consistency check with green/red badge.

Analytics & SPARQL¶

Graph statistics, ontology metrics, LOD cloud links, path finder. SPARQL Explorer and OntoSniff quality checker.

Customizable Layout¶

Change node colors, shapes, edge styles, and arrow types per element type — all from the toolbar.

Playground & Editor¶

Playground: paste TTL and visualize instantly — no install. SHACL Editor: build shapes visually with templates.

Live Demo¶

Here is a FOAF Person ontology with SHACL constraints — click nodes and edges, try editing the TTL, change shapes in Edit Layout:

Quick Start¶

1. Install from PyPI:

pip install ontoink

2. Add to your mkdocs.yml:

plugins:
  - search
  - ontoink

markdown_extensions:
  - pymdownx.superfences:
      preserve_tabs: true

3. Use in any markdown page:

```ontoink
source: path/to/data.ttl
shape: path/to/shape.ttl
```

4. Serve and explore:

mkdocs serve

Full Getting Started Guide

Built by ISE — FIZ Karlsruhe in the context of NFDI and NFDI-MatWerk

GitHub PyPI