j-bbr/Razor2Pdf

Renders APS.NET Core Razor Pages as PDFs using WeasyPrint

Razor2Pdf

Razor2Pdf renders ASP.NET Core Razor Pages as PDFs using WeasyPrint.

Usage

1. Ensure that the weasyprint command is in your PATH. You can:
   • follow the WeasyPrint installation instructions or
   • use our ASP.NET Core Runtime and WeasyPrint Docker image.
2. Add a reference to the NanoByte.Razor2Pdf NuGet package to your project.
3. Add a call to services.AddRazor2Pdf() in your ConfigureServices() method in Startup.cs.

You can now use dependency injection to get an instance of IPdfRenderer and use it like this:

FileStreamResult result = await pdfRenderer.RenderAsync("path/to/my/view", new MyViewModel(...));

See the sample project for more details.

Building

The source code is in src/, config for building the API documentation is in doc/ and generated build artifacts are placed in artifacts/. The source code does not contain version numbers. Instead the version is determined during CI using GitVersion.

To build run .\build.ps1 or ./build.sh (.NET SDK is automatically downloaded if missing using 0install).

Contributing

We welcome contributions to this project such as bug reports, recommendations and pull requests.

This repository contains an EditorConfig file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' ReSharper or Rider products.