footnote()

function footnote(index, value): Node;

Defined in: footnote.ts:60

Builder-element for a footnote

Parameters

Parameter	Type	Description
index	number	Index of the footnote
value	string | Node	Content of the footnote

Returns

Node

A markdown node

Example

import { define, footnote } from "@ogs-gmbh/markdown";

const markdown = define(
  foootnote(1, "It is described here")
);

console.assert(
  markdown.toString()
);

See

https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#footnotes

Since

1.0.0

Author

Simon Kovtyk