OgImgGen 1.0.1
dotnet add package OgImgGen --version 1.0.1
NuGet\Install-Package OgImgGen -Version 1.0.1
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="OgImgGen" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OgImgGen --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: OgImgGen, 1.0.1"
#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 OgImgGen as a Cake Addin
#addin nuget:?package=OgImgGen&version=1.0.1
// Install OgImgGen as a Cake Tool
#tool nuget:?package=OgImgGen&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
OgImgGen
Og image generation middleware for .net core with built in caching
Available on nuget package manager Nuget package
.net CLI: dotnet add package OgImgGen --version 1.0.1
Usage example
Query the required og image:
https://localhost:5001/ogimg.png?topText=Hello%20World&bottomText=Dynamically%20generated%20png%20og%20image
Enjoy the result:
Setup
Register in the Configure method
app.UseResponseCaching();
app.UseOgImgGen("/ogImg.png", "default-image.png", "font-you-want-to-use.ttf");
UseOgImgGen accepts 3 properties
- path, where the image will be generated
- defaultImage location, the location for an existing image
- font file location, the font to render on image
Query options
| query option | default value | description | type |
|---|---|---|---|
| topText | first line of the text | string? | |
| bottomText | second line of the text | string? | |
| theme | dark | defines the background and text color | "dark"|"light" |
| image | defaultImage from the UseOgImgGen method | a relative path to the image file | string? |
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 is compatible. net5.0-windows was computed. net6.0 was computed. 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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net5.0
- Microsoft.AspNetCore.Http.Abstractions (>= 2.2.0)
- SkiaSharp.Svg (>= 1.60.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.