Skip to content

Ⓜ Mermaid Plugin

Bundled with iolanta

The Mermaid plugin renders RDF graphs as Mermaid diagram syntax. It is the generic graph visualization layer that other bundled features can build on, including the Roadmap plugin.

Example

iolanta example.yamlld --as mermaid

graph LR
  https___example_org_alice("Alice")
  click https___example_org_alice "https://example.org/alice"
  https___example_org_bob("Bob")
  click https___example_org_bob "https://example.org/bob"
  http___www_w3_org_1999_02_22_rdf_syntax_ns_type("∈ type")
  click http___www_w3_org_1999_02_22_rdf_syntax_ns_type "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
  Literal_599dcce2998a[["type"]]
  https___schema_org_Person("🧑 Person")
  click https___schema_org_Person "https://schema.org/Person"
  Literal_40bed7cf9b3d[["Person"]]
  https___example_org_acme("ACME Corp")
  click https___example_org_acme "https://example.org/acme"
  Literal_3659f7cbbee8[["∈"]]
  https___schema_org_Organization("Organization")
  click https___schema_org_Organization "https://schema.org/Organization"
  Literal_b1329e756060[["🧑"]]
  https___example_org_alice --- Edge_e07195c8f4e7(["knows"])--> https___example_org_bob
  click Edge_e07195c8f4e7 "https://schema.org/knows"
  http___www_w3_org_1999_02_22_rdf_syntax_ns_type --- Edge_3dc22d788deb(["label"])--> Literal_599dcce2998a
  click Edge_3dc22d788deb "http://www.w3.org/2000/01/rdf-schema#label"
  https___example_org_alice --- Edge_9ff3d2b6fb3f(["∈ type"])--> https___schema_org_Person
  click Edge_9ff3d2b6fb3f "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
  https___schema_org_Person --- Edge_c8ec852019bc(["label"])--> Literal_40bed7cf9b3d
  click Edge_c8ec852019bc "http://www.w3.org/2000/01/rdf-schema#label"
  https___example_org_alice --- Edge_9c57a8625816(["affiliation"])--> https___example_org_acme
  click Edge_9c57a8625816 "https://schema.org/affiliation"
  http___www_w3_org_1999_02_22_rdf_syntax_ns_type --- Edge_b23eb2d84010(["🖼️ icon"])--> Literal_3659f7cbbee8
  click Edge_b23eb2d84010 "https://iolanta.tech/icon"
  https___example_org_bob --- Edge_4f42f6ad4728(["∈ type"])--> https___schema_org_Person
  click Edge_4f42f6ad4728 "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
  https___example_org_acme --- Edge_7694d8460813(["∈ type"])--> https___schema_org_Organization
  click Edge_7694d8460813 "http://www.w3.org/1999/02/22-rdf-syntax-ns#type"
  https___schema_org_Person --- Edge_936cc5e8ba61(["🖼️ icon"])--> Literal_b1329e756060
  click Edge_936cc5e8ba61 "https://iolanta.tech/icon"
  classDef predicate fill:#1f2233,stroke:transparent,color:#f8fafc,stroke-width:0px;
  classDef hidden fill:transparent,stroke:transparent,color:transparent,stroke-width:0px;
  classDef nanopubdot fill:#0f172a,stroke:#0f172a,color:transparent,stroke-width:2px;
  classDef transparent fill:transparent,stroke:transparent,color:transparent,stroke-width:0px;
  class Edge_e07195c8f4e7,Edge_3dc22d788deb,Edge_9ff3d2b6fb3f,Edge_c8ec852019bc,Edge_9c57a8625816,Edge_b23eb2d84010,Edge_4f42f6ad4728,Edge_7694d8460813,Edge_936cc5e8ba61 predicate

Quick Start

Render any YAML-LD or RDF document graph as a Mermaid diagram:

iolanta path/to/document.yamlld --as mermaid

Datatype

The plugin outputs https://iolanta.tech/datatypes/mermaid, an iolanta:OutputDatatype for Mermaid diagram syntax.

Roadmap rendering specializes this output datatype as https://iolanta.tech/roadmap/datatypes/mermaid, so generic graph diagrams and roadmap diagrams remain separate render targets.

  • Ⓜ pkg:pypi/iolanta#mermaid-graph

    Generic RDF graph renderer for https://iolanta.tech/datatypes/mermaid.

  • ◌ pkg:pypi/iolanta#mermaid-nanopublication

    Specialized Mermaid renderer for nanopublications.