Skip to main content

Link

A hyperlink to other pages, sections within the same document, resources, or any URL.

!array('Analogues of ')Link!array(' in other schema include:')

This schema type is marked as unstable ⚠️ and is subject to change.

Properties#

Name@idTypeDescriptionInherited from
contentstencila:contentArray of InlineContentThe textual content of the link.Link
targetstencila:targetFormat 'uri-reference'The target of the link.Link
exportFromstencila:exportFromstringA compilation directive giving the name of the variable to export to the link target.Link
idschema:idstringThe identifier for this item.Entity
importTostencila:importTostringA compilation directive giving the name of the variable to import the link target as.Link
metastencila:metaobjectMetadata associated with this item.Entity
relationschema:linkRelationshipstringThe relation between the target and the current thing.Link
titleschema:headlinestringA title for the link. See note 1.Link

Notes#

  1. title : !array('This property is analogous to the HTML ')title!array(' global attribute which represents ')!array('"advisory information related to the element"')

Examples#

{
"type": "Link",
"content": [
"Stencila’s website"
],
"target": "https://stenci.la"
}

Related#

  • Parent: Entity
  • Descendants: None

Available as#

Source#

This documentation was generated from Link.schema.yaml.