literalMD

lib.options.literalMD

Docs pulled from | This Revision | 10 minutes ago

For use in the defaultText and example option attributes. Causes the given MD text to be inserted verbatim in the documentation, for when a literalExpression would be too hard to read.

Inputs

text: 1. Function argument

Noogle detected

Aliases

lib.literalMD

Implementation

The following is the current implementation of this function.

literalMD =
    text:
    if !isString text then
      throw "literalMD expects a string."
    else
      {
        _type = "literalMD";
        inherit text;
      };