F# – PDF fun with Markdown and FSharp.Formatting

Yan Cui

I help clients go faster for less using serverless technologies.

This article is brought to you by

The real-time data platform that empowers developers to build innovative products faster and more reliably than ever before.

Learn more

I spent the last couple of nights putting together a simple Markdown to PDF formatter using Tomas Petricek’s FSharp.Formatting project and the PdfSharp-MigraDoc library.

To use this library, you can either grab the source from the GitHub repository or get it from Nuget using the following command:

NuGet package

F# Usage

To use the library from F#, you can use the Markdown type defined in the FSharp.Markdown namespace (from the FSharp.Formating library), once you’ve opened the FSharp.Markdown.Pdf namespace you’ll have access to two static extension methods:

  • TransformPdf – accepts a string as input and outputs the resulting PDF to a local file path or to a specified Stream.
  • WritePdf – accepts a MarkdownDocument generated by the Markdown.Parse method, and outputs the resulting PDF to a local file path or to a specified Stream.

C# Usage

You can also use this library from C#, however, the static extension methods mentioned above is not accessible in C# because type extensions defined in F# are compiled differently to standard extension methods you find in C# (with far more possibilities I might add, such as extension properties, and static methods, for instance!) and is not recognized by the C# compiler..

You can still access the same functionalities using a MarkdownPdf type, with two static methods:

  • Transform – equivalent to Markdown.TransformPdf.
  • Write – equivalent to Markdown.WritePdf.

You can see an example output here with the corresponding Markdown here.

Whenever you’re ready, here are 4 ways I can help you:

  1. Production-Ready Serverless: Join 20+ AWS Heroes & Community Builders and 1000+ other students in levelling up your serverless game. This is your one-stop shop for quickly levelling up your serverless skills.
  2. Do you want to know how to test serverless architectures with a fast dev & test loop? Check out my latest course, Testing Serverless Architectures and learn the smart way to test serverless.
  3. I help clients launch product ideas, improve their development processes and upskill their teams. If you’d like to work together, then let’s get in touch.
  4. Join my community on Discord, ask questions, and join the discussion on all things AWS and Serverless.

2 thoughts on “F# – PDF fun with Markdown and FSharp.Formatting”

  1. Pingback: Customizing document styles with FSharp.Markdown.Pdf | theburningmonk.com

  2. Pingback: Year in Review, 2013 | theburningmonk.com

Leave a Comment

Your email address will not be published. Required fields are marked *