link()

function link(href, alt?): Node;

Defined in: link.ts:27

Builder-element for a link

Parameters

Parameter	Type	Description
href	string | Node	Href of the link
alt?	string | Node	Alt-text of the link

Returns

Node

A markdown node

Example

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

const markdown = define(
  link("https://www.ogs.de", "Best company")
);

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#links

Since

1.0.0

Author

Simon Kovtyk