Reference for MarkdownDoc
The MarkdownDoc
is the entity returned by chunknorris
's parsers. It's purpose it mainly to be fed to the MarkdownChunker
.
Bases: BaseModel
A parsed Markdown Formatted-String, resulting in a list of MarkdownLine. Feats : - ATX header formatting. - Remove base64 images
from_string(md_string)
staticmethod
Get the MardownDoc object from a markdown formatted string.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
md_string
|
str
|
the markdown string |
required |
Returns:
Name | Type | Description |
---|---|---|
MarkdownDoc |
MarkdownDoc
|
the markdown document |
to_string()
Get the markdown string corresponding to the document's content