Class MarkdownLoader

Document loader for Markdown (.md) and MDX (.mdx) files.

Front-matter handling

YAML front-matter delimited by --- is parsed via gray-matter. All key-value pairs are merged into DocumentMetadata as-is, with a handful of well-known keys (title, author, createdAt, modifiedAt, language) mapped to the corresponding typed metadata fields.

Title extraction fallback

When the front-matter does not contain a title field the loader searches the document body for the first level-1 ATX heading (# Title) and uses that as the title.

Returned content

The content field in the returned LoadedDocument contains the Markdown body without the front-matter block.

Implements

Example

const loader = new MarkdownLoader();
const doc = await loader.load('/docs/architecture.md');
console.log(doc.metadata.title); // from front-matter or first # heading

Implements

Constructors

constructor

Methods

canLoad load

Properties

supportedExtensions

Constructors

constructor

Methods

canLoad

  • canLoad(source): boolean

  • Returns true when this loader is capable of handling source.

    For string sources the check is purely extension-based. For Buffer sources the loader may inspect magic bytes when relevant.

    Parameters

    • source: string | Buffer<ArrayBufferLike>

      Absolute file path or raw bytes.

    Returns boolean

load

  • load(source, _options?): Promise<LoadedDocument>

  • Parses source and returns a normalised LoadedDocument.

    When source is a string the loader treats it as an absolute (or resolvable) file path and reads the file from disk. When source is a Buffer the loader parses the bytes directly and derives as much metadata as possible from the buffer content alone.

    Parameters

    • source: string | Buffer<ArrayBufferLike>

      Absolute file path OR raw document bytes.

    • Optional _options: LoadOptions

      Optional hints such as a format override.

    Returns Promise<LoadedDocument>

    A promise resolving to the fully-populated LoadedDocument.

    Throws

    When the file cannot be read or the format is not parsable.

Properties

Readonly supportedExtensions

supportedExtensions: string[] = ...

File extensions this loader handles, each with a leading dot.

Used by LoaderRegistry to route file paths to the correct loader.

Example

['.md', '.mdx']

Settings

Member Visibility

Theme

On This Page

constructorcanLoadloadsupportedExtensions