Class: MarkdownReader
Extract text from markdown files. Returns dictionary with keys as headers and values as the text between headers.
Implements
Constructors
constructor
• new MarkdownReader(removeHyperlinks?, removeImages?): MarkdownReader
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
removeHyperlinks? | boolean | true | Indicates whether hyperlinks should be removed. |
removeImages? | boolean | true | Indicates whether images should be removed. |
Returns
Defined in
packages/core/src/readers/MarkdownReader.ts:20
Properties
_removeHyperlinks
• Private _removeHyperlinks: boolean
Defined in
packages/core/src/readers/MarkdownReader.ts:13
_removeImages
• Private _removeImages: boolean
Defined in
packages/core/src/readers/MarkdownReader.ts:14
Methods
loadData
▸ loadData(file, fs?): Promise<Document<Metadata>[]>
Parameters
| Name | Type | Default value |
|---|---|---|
file | string | undefined |
fs | GenericFileSystem | defaultFS |
Returns
Implementation of
Defined in
packages/core/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
| Name | Type | Description |
|---|---|---|
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/core/src/readers/MarkdownReader.ts:31
parseTups
▸ parseTups(content): MarkdownTuple[]
Parameters
| Name | Type |
|---|---|
content | string |
Returns
MarkdownTuple[]
Defined in
packages/core/src/readers/MarkdownReader.ts:80
removeHyperlinks
▸ removeHyperlinks(content): string
Parameters
| Name | Type |
|---|---|
content | string |
Returns
string
Defined in
packages/core/src/readers/MarkdownReader.ts:75
removeImages
▸ removeImages(content): string
Parameters
| Name | Type |
|---|---|
content | string |
Returns
string