ScissorHands.Core

ScissorHands.Core

ScissorHands.Core contains the shared contracts, manifests, models, and command options used by the ScissorHands.NET static site generator.

Most applications should install ScissorHands.Web, which references this package automatically. Install ScissorHands.Core directly when building a custom integration, theme service, or Markdown service.

Install

dotnet add package ScissorHands.Core --prerelease

ScissorHands.NET currently targets .NET 10.

Content models

ContentDocument represents a Markdown source document as it moves through the generation pipeline:

using ScissorHands.Core.Models;

var document = new ContentDocument
{
    SourcePath = "contents/posts/hello.md",
    Kind = ContentKind.Post,
    Metadata = new ContentMetadata
    {
        Title = "Hello",
        Slug = "hello",
        Tags = ["dotnet", "static-site"],
        Published = DateTimeOffset.UtcNow,
    },
    Markdown = "# Hello",
};

The package also provides site/theme/plugin manifests, immutable NavigationNode data, shared URL helpers, command options, and cancellation-aware Markdown/theme service contracts. Treat collection inputs as read-only.

vNext changes several collection APIs and requires plugin IDs. Legacy non-cancellable IThemeService overloads are obsolete; review the migration reference before upgrading.

Generated page navigation

PageNavigation and PageNavigationLink provide optional, immutable previous/next page data for themes. They are generated models, not frontmatter.

See the page navigation API reference and theme integration guide for their contracts and usage.

Learn more

• ScissorHands.Web package
• vNext API reference (website handoff)
• vNext migration reference
• Documentation
• Source code
• Issue tracker

License

ScissorHands.NET is licensed under the MIT License.