NanoByte.Razor2Pdf 0.3.0

dotnet add package NanoByte.Razor2Pdf --version 0.3.0
NuGet\Install-Package NanoByte.Razor2Pdf -Version 0.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NanoByte.Razor2Pdf" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add NanoByte.Razor2Pdf --version 0.3.0
#r "nuget: NanoByte.Razor2Pdf, 0.3.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install NanoByte.Razor2Pdf as a Cake Addin
#addin nuget:?package=NanoByte.Razor2Pdf&version=0.3.0

// Install NanoByte.Razor2Pdf as a Cake Tool
#tool nuget:?package=NanoByte.Razor2Pdf&version=0.3.0

Razor2Pdf

Build NuGet API documentation
Razor2Pdf renders ASP.NET Core Razor Pages as PDFs using WeasyPrint.

Usage

  1. Ensure that the weasyprint command is in your PATH. You can:
  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).

You can use also user Docker Compose to build the library and run the included sample project at http://localhost:8080/:

cd src
docker-compose up

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.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.3.0 188 12/3/2023
0.2.1 97 9/10/2023
0.2.0 647 10/2/2020
0.1.1 551 7/25/2020
0.1.0 539 7/11/2020