Broiler.Documents
0.1.0-preview.36
dotnet add package Broiler.Documents --version 0.1.0-preview.36
NuGet\Install-Package Broiler.Documents -Version 0.1.0-preview.36
<PackageReference Include="Broiler.Documents" Version="0.1.0-preview.36" />
<PackageVersion Include="Broiler.Documents" Version="0.1.0-preview.36" />
<PackageReference Include="Broiler.Documents" />
paket add Broiler.Documents --version 0.1.0-preview.36
#r "nuget: Broiler.Documents, 0.1.0-preview.36"
#:package Broiler.Documents@0.1.0-preview.36
#addin nuget:?package=Broiler.Documents&version=0.1.0-preview.36&prerelease
#tool nuget:?package=Broiler.Documents&version=0.1.0-preview.36&prerelease
Broiler.Documents
Broiler.Documents is Broiler's format-independent rich-text document core: the
UI-free document model, headless page layout, deterministic Formatting Codes
projection, and the codec contract, catalog, options, limits, diagnostics, and
resource-policy primitives.
Format-specific codecs (RTF, DOCX, ODT, HTML, Markdown, CSV, XLSX, ODS, PDF)
and the broilerdoc command-line tool live in the companion repository
Broiler.Documents.Codecs.
Preview release.
0.1.0-preview.Npackages are previews. Public APIs and behaviour are not frozen and may change before1.0.
Installation
Preview packages need an explicit prerelease opt-in:
dotnet add package Broiler.Documents --prerelease
All dependencies (including upstream Broiler.Graphics) restore directly from
NuGet.org (https://api.nuget.org/v3/index.json).
Packages
Four preview packages are generated. All target net10.0, ship XML
documentation and a .snupkg symbol package, and are built deterministically
with SourceLink.
| Package | Role |
|---|---|
Broiler.Documents.Model |
Platform-neutral rich-text document model, promoted out of Broiler.UI.RichEdit; depends only on Broiler.Graphics. |
Broiler.Documents.Pagination |
Headless page layout over the model: lays a document out on pages of a Broiler.Graphics.Paging page setup and paints each as a BPage for printing, print preview and fixed-page output. References only the model and Broiler.Graphics. |
Broiler.Documents.FormatCodes |
Deterministic, versioned Formatting Codes projection: typed tokens, source mappings, diagnostics, and resource policy. References only the model. |
Broiler.Documents |
Format-neutral codec contract, catalog, descriptors, source hints, read/write options, limits, diagnostics, conversion context, and probe results. References only the model. |
Dependency direction
Broiler.Documents.Model -> Broiler.Graphics
Broiler.Documents -> Broiler.Documents.Model
Broiler.Documents.Pagination -> Broiler.Documents.Model, Broiler.Graphics
Broiler.Documents.FormatCodes -> Broiler.Documents.Model
Component Constraints
- Target .NET 10 only.
- Do not add third-party runtime dependencies.
- Keep all core assemblies format-independent, platform-neutral, safe-code compatible, trimming-friendly, and AOT-friendly.
- Do not add hidden global codec registration or module-initializer side effects.
Broiler.Documents.ModelandBroiler.Documentsmust not referenceBroiler.UI,Broiler.DOM,Broiler.Input, or any*.Windowsassembly.
Architecture tests in Broiler.Documents.Tests and Broiler.Documents.Model.Tests
enforce these constraints against the project files and exported assemblies.
Repository layout
src/ core runtime assemblies, one directory per package
src/tests/ one xUnit test project per assembly
eng/ vendored packaging metadata, package icon, build/test scripts
docs/ core roadmap, architecture notes, guides, ADRs
.github/workflows/ CI and publish pipelines
Directory.Packages.props centrally pinned Broiler and test package versions
Broiler.Documents.slnx solution over every core project in src/
Building, testing, and packaging
dotnet build Broiler.Documents.slnx -c Release
Run all unit test projects:
pwsh -File ./eng/run-tests.ps1 -Configuration Release
Pack and verify the four core packages:
pwsh -File ./eng/pack.ps1
License
Broiler.Documents is licensed under the Apache License 2.0.
| Product | Versions 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. |
-
net10.0
- Broiler.Documents.Model (>= 0.1.0-preview.36)
NuGet packages (9)
Showing the top 5 NuGet packages that depend on Broiler.Documents:
| Package | Downloads |
|---|---|
|
Broiler.Documents.Rtf
RTF reader/writer codec for Broiler.Documents over the documented first-release RTF subset. |
|
|
Broiler.Documents.Pdf
PDF 1.7 (ISO 32000-1) document codec: syntax, object store, the stream filters this repository implements, logical text import, and a deterministic writer over the standard font names. |
|
|
Broiler.Documents.Docx
DOCX document codec for Broiler.Documents over Open XML WordprocessingML packages. |
|
|
Broiler.Documents.Html
HTML document codec for Broiler.Documents over the canonical Broiler DOM and HTML parser. |
|
|
Broiler.Documents.Markdown
Markdown document codec for Broiler.Documents over a safe CommonMark-oriented subset. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 0.1.0-preview.36 | 141 | 11/19/2026 |
| 0.1.0-preview.35 | 93 | 11/18/2026 |
| 0.1.0-preview.34 | 143 | 11/17/2026 |
| 0.1.0-preview.33 | 113 | 11/12/2026 |
| 0.1.0-preview.32 | 220 | 11/6/2026 |
| 0.1.0-preview.31 | 532 | 10/30/2026 |
| 0.1.0-preview.30 | 111 | 10/30/2026 |
| 0.1.0-preview.29 | 115 | 10/30/2026 |
| 0.1.0-preview.28 | 175 | 10/23/2026 |
| 0.1.0-preview.27 | 159 | 10/16/2026 |
| 0.1.0-preview.26 | 118 | 10/15/2026 |
| 0.1.0-preview.25 | 154 | 10/14/2026 |
| 0.1.0-preview.24 | 113 | 10/12/2026 |
| 0.1.0-preview.23 | 221 | 10/12/2026 |
| 0.1.0-preview.22 | 138 | 10/11/2026 |
| 0.1.0-preview.21 | 315 | 9/24/2026 |
| 0.1.0-preview.20 | 110 | 9/24/2026 |
| 0.1.0-preview.19 | 178 | 9/24/2026 |
| 0.1.0-preview.18 | 114 | 9/23/2026 |
| 0.1.0-preview.17 | 109 | 9/23/2026 |