rule()

function rule(type?, repeats?): Node;

Defined in: rule.ts:43

Builder-element for a horizontal rule

Parameters

Parameter	Type	Default value	Description
type?	RuleType	undefined	Type of this element
repeats?	number	3	Number of repeating characters

Returns

Node

A markdown node

Example

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

const markdown = define(
  rule("hyphen")
);

console.assert(
  markdown.toString()
);

See

https://github.com/adam-p/markdown-here/wiki/markdown-cheatsheet#hr

Since

1.0.0

Author

Simon Kovtyk