annotatedtext-rehype - v1.0.12
    Preparing search index...

    Interface IOptions

    interface IOptions {
        rehypeoptions: Options;
        annotatetextnode(node: INode, text: string): null | IAnnotation;
        children(node: INode): INode[];
        interpretmarkup(text?: string): string;
    }
    Index

    Properties

    rehypeoptions: Options

    The options to use for parsing the HTML.

    Methods

    • A function that returns an annotated text node.

      Parameters

      • node: INode
      • text: string

      Returns null | IAnnotation

    • A function that returns the children of a node.

      Parameters

      • node: INode

      Returns INode[]

    • A function that returns a string representing how markup should be interpreted.

      Parameters

      • Optionaltext: string

      Returns string