Quick start guide Leave feedback
On this page
This guide shows you how to convert documents to Markdown with GroupDocs.Markdown for .NET. You’ll have working code in under 2 minutes.
flowchart LR
A["Input Document\n(DOCX, PDF, XLSX, EPUB, ...)"]
B["MarkdownConverter"]
C["Markdown Output\n(.md file or string)"]
A --> B --> C
- Install the NuGet package:
dotnet add package GroupDocs.Markdown
Install-Package GroupDocs.Markdown
- Add the namespace:
using GroupDocs.Markdown;
The simplest conversion — one line of code:
using GroupDocs.Markdown;
// Convert a Word document to Markdown
string markdown = MarkdownConverter.ToMarkdown("business-plan.docx");
Console.WriteLine(markdown);
// Or save directly to a file
MarkdownConverter.ToFile("business-plan.docx", "business-plan.md");
business-plan.docx is a sample file used in this example. Click here to download it.
Save a PDF to Markdown with images extracted to a folder:
using GroupDocs.Markdown;
var options = new ConvertOptions
{
ImageExportStrategy = new ExportImagesToFileSystemStrategy("output/images")
{
ImagesRelativePath = "images"
}
};
MarkdownConverter.ToFile("report.pdf", "output/report.md", options);
// Images saved to output/images/
// Markdown references: 
report.pdf is a sample file used in this example. Click here to download it.
Convert a spreadsheet with column truncation and front matter:
using GroupDocs.Markdown;
var options = new ConvertOptions
{
MaxColumns = 8,
MaxRows = 50,
IncludeFrontMatter = true,
Flavor = MarkdownFlavor.GitHub
};
using var converter = new MarkdownConverter("budget.xlsx");
// Inspect before converting
DocumentInfo info = converter.GetDocumentInfo();
Console.WriteLine($"Worksheets: {info.PageCount}");
// Convert
ConvertResult result = converter.Convert(options);
Console.WriteLine(result.Content);
// Check warnings
foreach (string w in result.Warnings)
Console.WriteLine($"Warning: {w}");
budget.xlsx is a sample file used in this example. Click here to download it.
- Supported document formats — full list of input formats
- Image handling strategies — Base64, file system, skip, custom
- Markdown flavor control — GitHub vs CommonMark
- YAML front matter — for static site generators
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
