DocNoteBox class

Represents a note box, which is typically displayed as a bordered box containing informational text.

DocNoteBox

Summary

Represents a note box, which is typically displayed as a bordered box containing informational text.

Signature

export declare class DocNoteBox extends DocNode 

Constructors

constructor

Constructs a new instance of the class

Properties

content

Modifiers: readonly Type:readonly content: DocSection; Default: “

kind

Modifiers: readonly Type:get kind(): string; Default: “

Methods

onGetChildNodes

Modifiers: protected

Events

No events defined.

Remarks

Note boxes are rendered as Mintlify <Note> components, which provide visual emphasis for important information, warnings, tips, or other callout content. The content can include any section-level nodes like paragraphs, code blocks, and lists.

Examples

Example 1

Related Documentation

• Custom AST nodes architecture