ScissorHands.Plugin.OpenGraph 1.0.0-preview.20260915.1

This is a prerelease version of ScissorHands.Plugin.OpenGraph.

dotnet add package ScissorHands.Plugin.OpenGraph --version 1.0.0-preview.20260915.1

NuGet\Install-Package ScissorHands.Plugin.OpenGraph -Version 1.0.0-preview.20260915.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="ScissorHands.Plugin.OpenGraph" Version="1.0.0-preview.20260915.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="ScissorHands.Plugin.OpenGraph" Version="1.0.0-preview.20260915.1" />
                    

                            Directory.Packages.props

<PackageReference Include="ScissorHands.Plugin.OpenGraph" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add ScissorHands.Plugin.OpenGraph --version 1.0.0-preview.20260915.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: ScissorHands.Plugin.OpenGraph, 1.0.0-preview.20260915.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.

#:package ScissorHands.Plugin.OpenGraph@1.0.0-preview.20260915.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=ScissorHands.Plugin.OpenGraph&version=1.0.0-preview.20260915.1&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=ScissorHands.Plugin.OpenGraph&version=1.0.0-preview.20260915.1&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

ScissorHands.NET: Open Graph Plugin

Adds Open Graph and Twitter-card metadata to a compatible ScissorHands.NET site.

Getting Started

Install the preview package in your ScissorHands.NET host:

dotnet add package ScissorHands.Plugin.OpenGraph --prerelease

Configure the site and plugin in appsettings.json:

{
  "Site": {
    "SiteUrl": "https://example.com",
    "BaseUrl": "/blog/",
    "Title": "My site",
    "Description": "About this site",
    "Locale": "en-US",
    "HeroImage": "/images/site.png"
  },
  "Plugins": [
    {
      "Id": "open-graph",
      "Options": {
        "TwitterSiteId": "@example",
        "TwitterCreatorId": "@author"
      }
    }
  ]
}

TwitterSiteId identifies the website's account; TwitterCreatorId is the default post-author handle. Both are optional: omit either or use "Options": {}. Null, non-string and whitespace-only values omit their optional tags.

In a layout supplied with the engine's cascading context, place the component inside <head>:

<OpenGraphComponent Id="open-graph" />

Alternatively, use the paired placeholder for the post-HTML hook:

<plugin:open-graph></plugin:open-graph>

Choose one path per insertion to avoid duplicates. Hook placeholders must be paired, not self-closing; every matching pair is replaced. The Id is exact and case-sensitive; an optional manifest Name is only a display label. Remove the entry from Plugins to disable output.

Metadata and publication URLs

Given equivalent host context, both integrations produce equivalent metadata:

Individual source-backed documents use Document title | Site title and the document description, falling back to the site description only when null. Collections, source-less documents and missing documents use site title/description.
twitter:creator appears only for an individual source-backed post, not pages, collections or source-less posts. A nonblank document TwitterHandle overrides TwitterCreatorId.
A nonblank document hero image wins over the site image. When neither exists, both image tags are omitted; the card remains summary_large_image.

Suppressing the inherited image: the released SiteManifest supplies an external hero.jpg by default. Omitting Site.HeroImage therefore does not necessarily remove image metadata. Set "HeroImage": "" inside Site and leave the document image absent to omit both image tags.

Configured output requires site context and an absolute HTTP(S) SiteUrl with a host and no query/fragment. A path on SiteUrl is preserved. BaseUrl is an optional local path prefix, not an absolute/network URL or a query/fragment; use "" or "/" for root deployment. Blank/root content slugs map to this publication root. In the example above, /post becomes https://example.com/blog/post, and /images/site.png becomes https://example.com/blog/images/site.png.

Generated tag pages: verified with engine 1.0.0-preview.20260915.1, both modes receive the resolved route and emit the same canonical URL, including escaped tag names. Custom layouts must forward Document through CascadingMainLayoutBase. Generated routes are consumed as supplied, not reconstructed from tag labels or escaped twice. The earlier component limitation is resolved as OG-Q-005.

When upgrading from an older cached engine, refresh floating dependencies with dotnet restore --force-evaluate --no-cache, then rebuild. Hosts on 1.0.0-preview.20260914.1 still need hook mode for tag-page canonical URLs; a plugin update alone cannot supply their missing component context.

Images accept local paths, including a single leading / or local backslash separators, and absolute HTTP(S) URLs with a host. External origins, supported queries/fragments, existing percent encoding and meaningful trailing slashes are preserved. Unsupported schemes (data:, javascript:, file:, ftp:, etc.), malformed references/percent escapes, control characters and network paths such as //host/image.png or \\host\image.png are rejected. Use explicit HTTP(S) URLs for external images and prefer percent-encoded spaces.

The plugin does not mount the host at BaseUrl. See the technical requirements for complete metadata, URL, lifecycle and verification contracts.

Breaking migration from the earlier permissive behavior

Supply valid publication context wherever enabled. Invalid origins now fail with a field-specific error instead of relative URLs/default tags; an absent hook marker does not hide invalid configuration.
Correct unsupported image references. Errors identify Site.HeroImage or Document.Metadata.HeroImage without echoing arbitrary input.
Account for omitted image/creator tags. Clear the inherited site image explicitly if no image is wanted.
Supply original metadata text, not HTML or pre-encoded entities. Both integrations treat metadata as data.

An absent manifest remains silent without validating unused site/image context. Components refresh as context changes; provide site context before enabling and disable before removing it.

Preview and privacy

Configured preview and production use the same rules. Generation does not fetch images or contact social providers, but a later browser/crawler may request emitted external images. Metadata generation does not guarantee crawler acceptance or rich-preview appearance.

Support

See the shared support and recovery policy for best-effort issue support and preview-release recovery.

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- ScissorHands.Plugin (>= 1.0.0-preview.20260915.1)

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
1.0.0-preview.20260915.1	77	9/15/2026