Skip to main content

Class: MarkdownReader

Extract text from markdown files. Returns dictionary with keys as headers and values as the text between headers.

Extends

Constructors

new MarkdownReader()

new MarkdownReader(removeHyperlinks?, removeImages?): MarkdownReader

Parameters

removeHyperlinks?: boolean = true

Indicates whether hyperlinks should be removed.

removeImages?: boolean = true

Indicates whether images should be removed.

Returns

MarkdownReader

Overrides

FileReader.constructor

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:17

Methods

loadData()

loadData(filePath): Promise<Document<Metadata>[]>

Parameters

filePath: string

Returns

Promise<Document<Metadata>[]>

Inherited from

FileReader.loadData

Defined in

packages/core/schema/dist/schema/index.d.ts:187


loadDataAsContent()

loadDataAsContent(fileContent): Promise<Document<Metadata>[]>

Parameters

fileContent: Uint8Array

Returns

Promise<Document<Metadata>[]>

Overrides

FileReader.loadDataAsContent

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:91


markdownToTups()

markdownToTups(markdownText): MarkdownTuple[]

Convert a markdown file to a dictionary. The keys are the headers and the values are the text under each header.

Parameters

markdownText: string

The markdown text to convert.

Returns

MarkdownTuple[]

  • An array of tuples, where each tuple contains a header (or null) and its corresponding text.

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:29


parseTups()

parseTups(content): MarkdownTuple[]

Parameters

content: string

Returns

MarkdownTuple[]

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:80


removeHyperlinks(content): string

Parameters

content: string

Returns

string

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:75


removeImages()

removeImages(content): string

Parameters

content: string

Returns

string

Defined in

packages/llamaindex/src/readers/MarkdownReader.ts:70


addMetaData()

static addMetaData(filePath): (doc, index) => void

Parameters

filePath: string

Returns

Function

Parameters

doc: Document<Metadata>

index: number

Returns

void

Inherited from

FileReader.addMetaData

Defined in

packages/core/schema/dist/schema/index.d.ts:188