comment()

function comment(value): Node;

Defined in: comment.ts:26

Builder-element for an comment

Parameters

Parameter	Type	Description
value	string | Node	Content of this element

Returns

Node

A markdown node

Example

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

const markdown = define(
 comment("I like this lib")
);

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#hiding-content-with-comments

Since

1.0.0

Author

Simon Kovtyk