LinkKind

The LinkKind enum distinguishes the type of link in a Markdown file.

Definition

Source Code

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.

enum LinkKind {
  TextInline          # [<Text>](<Definition>)
  TextSelfReference   # [<Text>]
  TextUsingReference  # [<Text>][<Reference>]
  ImageInline         # ![<AltText>](<Definition>)
  ImageSelfReference  # ![<AltText>]
  ImageUsingReference # ![<AltText>][<Reference>]
  ReferenceDefinition # [<Name>]: <Definition>
}

Fields

TextInline

Indicates that the link is a text-link that includes its definition inline.

[<Text>](<Definition>)

TextSelfReference

Indicates that the link is a text-link that uses its own text as the reference definition.

[<Text>]

TextUsingReference

Indicates that the link is a text-link that references a definition in the file.

[<Text>][<ReferenceID>]

ImageInline

Indicates that the link is an image-link that includes its definition inline.

![<AltText>](<Definition>)

ImageSelfReference

Indicates that the link is an image-link that uses its own alt text as the reference definition.

![<AltText>]

ImageUsingReference

Indicates that the link is an image-link that references a definition in the file.

![<AltText>][<ReferenceID>]

ReferenceDefinition

Indicates that the link is the definition other links may reference by ID.

[<ReferenceID>]: <Definition>