SpecWorks.Sidemark 1.0.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package SpecWorks.Sidemark --version 1.0.0
                    


                    

                
NuGet\Install-Package SpecWorks.Sidemark -Version 1.0.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="SpecWorks.Sidemark" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="SpecWorks.Sidemark" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="SpecWorks.Sidemark" />
                    


                            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 SpecWorks.Sidemark --version 1.0.0
                    


                    

                
#r "nuget: SpecWorks.Sidemark, 1.0.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. 
#:package SpecWorks.Sidemark@1.0.0
#: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=SpecWorks.Sidemark&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=SpecWorks.Sidemark&version=1.0.0
                    


                            Install as a Cake Tool

Sidemark (.NET)

A .NET library for parsing, validating, and serializing Markdown Review Sidecar Format (MRSF) files according to the Sidemark v1.0 specification.

Features

  • Model — Strongly-typed MrsfDocument and MrsfComment classes covering all required and optional fields
  • Parser — Read .review.yaml and .review.json sidecar files into the model, with auto-format detection
  • Serializer — Write model instances back to YAML or JSON, omitting null optional fields
  • Validator — Full validation against MRSF v1.0 rules: required fields, cross-field constraints, reply_to resolution, selected_text_hash integrity
  • Discovery — Sidecar file discovery via co-location or .mrsf.yaml sidecar_root configuration (§3)

Quick Start

using Sidemark;

// Parse a sidecar file (auto-detects YAML vs JSON)
var doc = MrsfParser.ParseFile("docs/architecture.md.review.yaml");

// Validate
var result = MrsfValidator.Validate(doc);
if (!result.IsValid)
    foreach (var error in result.Errors)
        Console.WriteLine(error.Message);

// Discover sidecar for a Markdown file
var sidecarPath = MrsfDiscovery.DiscoverSidecar("docs/architecture.md", workspaceRoot: ".");

// Create and serialize
var newDoc = new MrsfDocument
{
    MrsfVersion = "1.0",
    Document = "docs/readme.md",
    Comments = new()
    {
        new MrsfComment
        {
            Id = Guid.NewGuid().ToString("N")[..8],
            Author = "Jane Doe (janedoe)",
            Timestamp = DateTimeOffset.UtcNow.ToString("o"),
            Text = "This section needs work.",
            Resolved = false,
            Line = 12,
            SelectedText = "The gateway component"
        }
    }
};
MrsfSerializer.WriteFile(newDoc, "docs/readme.md.review.yaml");

Building

dotnet build
dotnet test

Specification

See the full MRSF v1.0 specification and JSON Schema.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SpecWorks.Sidemark:

Package Downloads
SpecWorks.MarkMyWord

A .NET library for converting CommonMark markdown to Microsoft Word (.docx) documents with syntax highlighting and Mermaid diagrams. Supports headings, paragraphs, emphasis, code blocks with syntax highlighting (JSON, TypeSpec, Bash), Mermaid diagram rendering, links, images, lists, tables, and more.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 213 3/14/2026