Plugin SDK · .NET 10
Extend the engine without forking it.
Folio™ documents stay pure data. Plugins add new data connectors, document importers, renderers, font providers, and delivery channels — loaded in isolated contexts and verified by contract tests.
Architecture
Built like a compiler extension model.
A plugin is a .NET 10 class library with a plugin.json manifest and one IPluginModule class. You do not need the QuillWeaver source code to build, test, or validate a plugin.
Isolated load contexts
QuillWeaver discovers each plugin in plugins/<id>/ and loads it in its own assembly load context. Your third-party dependencies travel privately with your plugin and never collide with the host.
Shared-assembly boundary
The host provides Folio.Abstractions, QuillWeaver.Abstractions, and Microsoft.Extensions.*. Project templates automatically strip shared runtime copies during build so contract types always match.
Contract-tested & validated
Every extension point ships with an abstract contract test suite in QuillWeaver.Plugins.Testing, plus build-time validation through quill plugins validate (QW-PLUG-0001 through QW-PLUG-0015).
13 extension points
One keyed capability model across the stack.
Every capability is registered as a keyed service and declared in plugin.json. A plugin can add a new format or connector, or override a built-in capability key cleanly.
Data and delivery
Connect external databases, CRMs, archiving systems, and recipient channels.
| Extension point | Contract | Template | Example use cases |
|---|---|---|---|
| Data connector | IDataConnector | qw-plugin-data-connector | CRM APIs (Salesforce, Blackbaud, HubSpot), Airtable, Google Sheets, ERP views |
| Delivery channel | IDeliveryChannel | qw-plugin-delivery-channel | Postal mail APIs, Slack or Teams notices, webhook dispatchers, custom SMTP gateways |
| Document store | IDocumentStore | qw-plugin-document-store | SharePoint, Amazon S3, Azure Blob, Google Drive, compliance archive vaults |
| Job store | IJobStore | qw-plugin-job-store | PostgreSQL, SQL Server, or custom enterprise job state and audit ledgers |
Formats and visuals
Bring new source formats into Folio or emit specialized visual outputs.
| Extension point | Contract | Template | Example use cases |
|---|---|---|---|
| Document importer | IDocumentImporter | qw-plugin-document-importer | ICML, DOCX, Markdown, or proprietary legacy publishing formats with explicit loss reports |
| Output renderer | IRenderer | qw-plugin-renderer | Watermarked proof PDFs, print-press prepress profiles, custom archive or XML outputs |
| Chart renderer | IChartRenderer | qw-plugin-chart-renderer | Domain-specific financial, scientific, or engineering SVG chart engines |
| Image decoder | IImageDecoder | qw-plugin-image-decoder | Specialized raster or print color-space image formats |
Typography, templates, and diagnostics
Extend typesetting resources, template expressions, and operational telemetry.
| Extension point | Contract | Template | Example use cases |
|---|---|---|---|
| Font provider | IFontProvider | qw-plugin-font-provider | Organization font vaults, foundry font packs, or content-addressed font registries |
| Hyphenator | IHyphenator | qw-plugin-hyphenator | Regional language hyphenation dictionaries and specialized terminology rules |
| Template function | ITemplateFunction | qw-plugin-template-function | Custom Scriban helpers for domain currencies, tax rules, or legal citations |
| Template store | ITemplateStore | qw-plugin-template-store | Git-backed template repositories, CMS storage, or team template registries |
| Diagnostic sink | IDiagnosticSink | qw-plugin-diagnostic-sink | OpenTelemetry, structured audit logs, or compliance alerting pipelines |
Developer workflow
Green contract tests before line one.
Install the template pack, scaffold a plugin for any of the 13 extension points, and run the built-in contract suite. The generated stand-in passes every contract check immediately so you can replace TODOs step by step.
- QuillWeaver.PluginTemplates
- Scaffolds the plugin library, plugin.json manifest, xUnit v3 contract test project, and tool manifest.
- QuillWeaver.Plugins.Testing
- Provides PluginModuleContractTests<T> plus a dedicated contract suite for each of the 13 extension points.
- quill plugins validate
- Checks manifest schema, hostApiVersion compatibility, assembly loading, and keyed capability registration in CI or on build.
dotnet new install QuillWeaver.PluginTemplates
dotnet new qw-plugin-data-connector -n Acme.Crm
cd Acme.Crm
dotnet test
dotnet build
quill plugins validate ./Acme.Crm/bin/Release/net10.0dotnet build runs quill plugins validate automatically when the tool is available, verifying manifest schema, host API compatibility, and keyed capability registration before packaging.
SDK access & partnerships
Build with us as an early partner.
Public NuGet publishing for the open Folio packages and Plugin SDK is underway. In the meantime, we are onboarding early plugin authors and integration partners directly.
Open-source plugin maintainers
Building a community data connector, document importer, or language hyphenator? Request the early-access SDK bundle and direct engineering feedback.
Integrators & consultancies
Build private plugins that connect QuillWeaver to a client's CRM, ERP, or internal document store — deployed locally inside their own network.
Vertical SaaS & OEM partners
Embed deterministic Folio rendering or pair your platform's data model with QuillWeaver Designer and batch pipelines.
What is included in early SDK access: Early SDK access includes QuillWeaver.PluginTemplates, QuillWeaver.Plugins.Testing, Folio.Abstractions, QuillWeaver.Abstractions, the quill CLI, and 15+ reference sample plugins (including REST connector, SharePoint delivery, watermark renderer, and plain-text importer).
Templates, graphics & fonts
Creating visual content rather than C# plugins?
Designers, illustrators, type foundries, and domain authors can build templates visually in QuillWeaver Designer or contribute graphics and fonts on the Community page.
SDK FAQ
Technical questions answered directly.
Ready to build on the
Plugin SDK?
Tell us which connector, importer, renderer, or integration you want to build and we will get the SDK packages and sample plugins into your hands.