Perseus
    Preparing search index...
    • Run the Perseus linter over the specified markdown parse tree, with the specified context object, and return a (possibly empty) array of lint warning objects. If the highlight argument is true, this function also modifies the parse tree to add "lint" nodes that can be visually rendered, highlighting the problems for the user. The optional rules argument is an array of Rule objects specifying which lint rules should be applied to this parse tree. When omitted, a default set of rules is used.

      The context object may have additional properties that some lint rules require:

      context.content is the source content string that was parsed to create the parse tree.

      context.widgets is the widgets object associated with the content string

      Parameters

      • tree: any
      • context: any
      • highlight: boolean
      • rules: readonly Rule[] = allLintRules

      Returns readonly LinterWarning[]