Aspose.Cells FOSS
Python
MarkdownHandler

MarkdownHandler — Aspose.Cells FOSS for Python API Reference

aspose-cells-foss can export worksheet data as a GitHub-Flavored Markdown table via the MarkdownHandler class. A convenience method workbook.save_as_markdown(path) is also available directly on the Workbook class.

Package: aspose.cells_foss

from aspose.cells_foss import MarkdownHandler, MarkdownSaveOptions
from aspose.cells_foss import save_workbook_as_markdown

MarkdownSaveOptions

Options that control how the worksheet is serialized to Markdown.

Constructor 

MarkdownSaveOptions()

Properties

MarkdownSaveOptions has no configurable properties. Pass an instance to MarkdownHandler.save_markdown() to use default serialization behavior.

MarkdownHandler

MarkdownHandler contains only static methods and is never instantiated.

MarkdownHandler.save_markdown 

MarkdownHandler.save_markdown(workbook, file_path: str, options: MarkdownSaveOptions | None = None) -> None

Exports the first worksheet to a Markdown file at file_path. If options is None, default MarkdownSaveOptions are used.

MarkdownHandler.save_markdown_to_string 

MarkdownHandler.save_markdown_to_string(workbook, options: MarkdownSaveOptions | None = None) -> str

Serializes the worksheet to a Markdown string and returns it. No file is written.

Module Function

save_workbook_as_markdown 

save_workbook_as_markdown(workbook, file_path: str, options: MarkdownSaveOptions | None = None) -> None

Convenience wrapper around MarkdownHandler.save_markdown(workbook, file_path, options).

Workbook Convenience Method

Workbook.save_as_markdown(path) is a shorthand for exporting the first worksheet with default options:

wb.save_as_markdown("output.md")

Example

The following example builds a small product table and exports it to a Markdown string.

from aspose.cells_foss import Workbook, MarkdownHandler, MarkdownSaveOptions

wb = Workbook()
ws = wb.worksheets[0]
ws.name = "Products"

# Write table data (first row becomes the Markdown header)
rows = [
    ["Product", "Unit Price", "In Stock"],
    ["Widget A", 9.99, True],
    ["Widget B", 24.50, False],
    ["Widget C", 4.75, True],
]
for r, row in enumerate(rows):
    for c, val in enumerate(row):
        ws.cells[r][c].put_value(val)

opts = MarkdownSaveOptions()

# Get the Markdown as a string
md_text = MarkdownHandler.save_markdown_to_string(wb, options=opts)
print(md_text)

# Also save to a file
MarkdownHandler.save_markdown(wb, "products.md", options=opts)

Output (approximate):

| Product | Unit Price | In Stock |
|---|---|---|
| Widget A | 9.99 | True |
| Widget B | 24.5 | False |
| Widget C | 4.75 | True |

See Also