Convert Markdown to PDF | C#

MD is a markup language with a plain-text-formatting syntax. Markdown is often used as a format for documentation and readme files since it allows writing in an easy-to-read and easy-to-write style. Its design allows it to be easily converted to many output formats, but initially, it was created to convert only to HTML. Using the Aspose.HTML class library in your C# application, you can easily convert Markdown into a PDF file with just a few lines of code!

This article provides information on how to convert Markdown to PDF using the Aspose.HTML API. You will learn about the supported Markdown to PDF conversion scenarios and consider C# examples to illustrate them. Also, you can try an Online Markdown Converter to test the Aspose.HTML API functionality and convert Markdown on the fly.

Online Markdown Converter

You can convert Markdown to other formats with Aspose.HTML for .NET API in real time. Please load a Markdown file from the local file system, select the output format and run the example. The save options are set by default. You will immediately receive the conversion result as a separate file.

Code example in C# to convert document formats
Input file
Upload a file you want to convert
Output format
Select the target format

If you want to convert Markdown to PDF programmatically, please see the following C# code examples.

Convert Markdown to PDF in C#

If your scenario is required rendering Markdown document, for instance, to the PDF file format, the following example demonstrates how that is simple:

  1. Prepare a source Markdown document. In the example, we create a Markdown file from code.
  2. Prepare a path for converted file saving.
  3. Convert Markdown to HTML. Use the ConvertMarkdown(sourcePath) method to save Markdown as an HTML document.
  4. Use the ConvertHTML() method to render the intermediary HTML document to PDF format. You need to pass the HTMLDocument, PdfSaveOptions, and output file path to the ConvertHTML() method for HTML to PDF conversion.

If your case is to create a Markdown document from a user string directly in your code and convert it to a PDF file, the following example could help you:

using System.IO;
using Aspose.Html.Converters;
using Aspose.Html.Saving;
...
    // Prepare a path to a source Markdown file
    string sourcePath = Path.Combine(OutputDir, "document.md");

    // Prepare a simple Markdown example
    var code = "### Hello, World!" +
               "\r\n" +
               "[visit applications](https://products.aspose.app/html/family)";
    // Create a Markdown file
    File.WriteAllText(sourcePath, code);
    
    // Prepare a path for converted file saving 
    string savePath = Path.Combine(OutputDir, "document-output.pdf");
    
    // Convert Markdown to HTML document
    using var document = Converter.ConvertMarkdown(sourcePath);
    
    // Convert HTML document to PDF image file format
    Converter.ConvertHTML(document, new PdfSaveOptions(), savePath);

Convert Markdown to PDF using PdfSaveOptions

If your case is to convert an existing Markdown document from a local file system, the following example could help you. You need to follow a few steps:

  1. Open an existing Markdown document. In the example, we load a Markdown file from a local file system (nature.md).
  2. Prepare a path for converted PDF file saving.
  3. Convert Markdown to HTML. Use the ConvertMarkdown(sourcePath) method of the Converter class to save Markdown as an HTML document.
  4. Create a new PdfSaveOptions object and specify the required properties.
  5. Use the ConvertHTML() method to render the intermediary HTML document to PDF format. You need to pass the HTMLDocument, PdfSaveOptions, and output file path to the ConvertHTML() method.

The following code snippet shows how to convert Markdown to PDF using Aspose.HTML for .NET.

using System.IO;
using Aspose.Html.Converters;
using Aspose.Html.Saving;
using System.Drawing;
...
    // Prepare a path to a source Markdown file
    string sourcePath = Path.Combine(DataDir, "nature.md");

    // Prepare a path for converted PDF file saving 
    string savePath = Path.Combine(OutputDir, "nature-output.pdf");
    
    // Convert Markdown to HTML document
    using var document = Converter.ConvertMarkdown(sourcePath);
    
    // Initialize PdfSaveOptions. Set up the resolutions, JpegQuality and change the background color to AliceBlue 
    var options = new PdfSaveOptions()
    {
        HorizontalResolution = 200,
        VerticalResolution = 200,
        BackgroundColor = Color.AliceBlue,
        JpegQuality = 100
    };            
    
    // Convert HTML document to PDF image file format
    Converter.ConvertHTML(document, options, savePath);

The PdfSaveOptions class provides numerous properties that give you full control over a wide range of parameters and improve the process of converting Markdown to PDF format. To learn more about PdfSaveOptions, please read the Fine-Tuning Converters article.

In the above example, we use:

  • JpegQuality property that enables you to specify the quality of JPEG compression for images. The default value is 95;
  • BackgroundColor property that sets the color that will fill the background. The default BackgroundColor is Transparent;
  • HorizontalResolution and VerticalResolution properties that set horizontal/vertical resolution for output images in pixels per inch. By default, these properties are 300 dpi.

Text “Banner MD to PDF Converter”