FootnoteReference

import { FootnoteReference } from "jsr:@ende/markdown";

interface

interface FootnoteReference

A reference to a footnote, such as [^1]. Only parsed with the gfm option, and only when a FootnoteDefinition with the same identifier exists; otherwise the text stays as it is.

Example: Usage

import type { FootnoteReference } from "@ende/markdown/types";
import { assertEquals } from "@ende/assert";

const node: FootnoteReference = { type: "footnoteReference", identifier: "note", label: "Note" };
assertEquals(node.identifier, "note");

Properties

`type`

type: "footnoteReference"

Node type.

`identifier`

identifier: string

The normalized label (case-folded, with whitespace collapsed), which matches the identifier of its FootnoteDefinition.

`label`

label: string

The label as written in the source, without [^ and ].

Source