Broiler.Documents.Markdown
0.1.0-preview.37
dotnet add package Broiler.Documents.Markdown --version 0.1.0-preview.37
NuGet\Install-Package Broiler.Documents.Markdown -Version 0.1.0-preview.37
<PackageReference Include="Broiler.Documents.Markdown" Version="0.1.0-preview.37" />
<PackageVersion Include="Broiler.Documents.Markdown" Version="0.1.0-preview.37" />
<PackageReference Include="Broiler.Documents.Markdown" />
paket add Broiler.Documents.Markdown --version 0.1.0-preview.37
#r "nuget: Broiler.Documents.Markdown, 0.1.0-preview.37"
#:package Broiler.Documents.Markdown@0.1.0-preview.37
#addin nuget:?package=Broiler.Documents.Markdown&version=0.1.0-preview.37&prerelease
#tool nuget:?package=Broiler.Documents.Markdown&version=0.1.0-preview.37&prerelease
Broiler.Documents.Codecs
Broiler.Documents.Codecs holds Broiler's format-dependent document codecs and
the broilerdoc command-line tool, built over the format-independent core
packages from Broiler.Documents.
Preview release.
0.1.0-preview.Npackages are previews. Public APIs and behaviour are not frozen and may change before1.0. The codecs parse untrusted input — RTF control words, Open XML and OpenDocument packages, HTML, CSV records, and PDF object graphs — and must be treated as security-sensitive.
Installation
Add a package per format you actually read or write — none is pulled in automatically, and there is no meta-package:
dotnet add package Broiler.Documents.Rtf --prerelease
Packages
Eleven preview codec 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.Rtf |
RTF reader/writer for the documented first-release subset. |
Broiler.Documents.Docx |
DOCX reader/writer for a safe Open XML WordprocessingML subset. |
Broiler.Documents.Odt |
ODT reader/writer for a safe OASIS OpenDocument text subset. |
Broiler.Documents.Html |
HTML document/fragment codec over Broiler.Dom and Broiler.Dom.Html. |
Broiler.Documents.Markdown |
Markdown codec for a safe CommonMark-oriented subset. |
Broiler.Documents.Csv |
CSV/TSV codec: reads delimited values into a table in the model and writes tables back out. |
Broiler.Documents.Xlsx |
XLSX codec: reads and writes Open XML SpreadsheetML workbooks into and from the model. |
Broiler.Documents.Ods |
ODS codec: reads and writes OASIS OpenDocument spreadsheets into and from the model. |
Broiler.Documents.Pdf |
Preview PDF codec for logical text import and deterministic PDF 1.7 writing, plus PdfRasterPageWriter. |
Broiler.Documents.Pdf.Fonts |
Optional PDF font-program reader over Broiler.Graphics. |
Broiler.Documents.Pdf.Images |
Optional PDF image filters and ICC colour-profile reader over the managed Broiler.Media image codecs. |
Dependency direction
All format codecs consume Broiler.Documents and Broiler.Documents.Model as
versioned NuGet packages pinned in Directory.Packages.props:
Broiler.Documents.Rtf / Docx / Odt / Markdown / Csv / Xlsx / Ods / Pdf
-> Broiler.Documents, Broiler.Documents.Model
Broiler.Documents.Html
-> Broiler.Documents, Broiler.Documents.Model, Broiler.Dom, Broiler.Dom.Html
Broiler.Documents.Pdf.Fonts
-> Broiler.Documents.Pdf, Broiler.Graphics
Broiler.Documents.Pdf.Images
-> Broiler.Documents.Pdf, Broiler.Media.Image.Managed, Broiler.Graphics
Command line & conformance suites
src/Broiler.Documents.Cli (broilerdoc) composes the codecs and core
Broiler.Documents.Pagination / Broiler.Documents.FormatCodes packages to
create, edit, convert, render, and compare documents. It is held at
IsPackable=false.
src/tests/Broiler.Documents.Corpus: runs round-trip checks overbroilerdocagainsttests/corpus/corpus-baseline.json.src/tests/Broiler.Documents.Office: nightly/dispatchable LibreOffice conformance runner againsttests/office/office-baseline.json.
Building, testing, and packaging
dotnet build Broiler.Documents.Codecs.slnx -c Release
If developing against an unpublished local Broiler.Documents Core checkout in
../Broiler.Documents, pack Core first (pwsh -File ../Broiler.Documents/eng/pack.ps1 -Version 0.1.0-preview.36)
and restore Codecs against it:
pwsh -File ./eng/restore-local.ps1
dotnet build Broiler.Documents.Codecs.slnx -c Release --no-restore
For an unpublished Media dependency, pack the version pinned in
Directory.Packages.props from the Media checkout and pass its package directory
to pwsh -File ./eng/restore-local.ps1 -MediaArtifacts ../Broiler.Media/artifacts.
Pass -CoreArtifacts as well when testing with unpublished Core packages.
Run unit tests, the corpus suite, and package verification:
pwsh -File ./eng/run-tests.ps1 -Configuration Release
dotnet run --project src/tests/Broiler.Documents.Corpus -c Release --no-build
pwsh -File ./eng/pack.ps1
License
Broiler.Documents.Codecs 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 (>= 0.1.0-preview.36)
- Broiler.Documents.Model (>= 0.1.0-preview.36)
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 |
|---|---|---|
| 0.1.0-preview.37 | 55 | 11/19/2026 |
| 0.1.0-preview.36 | 50 | 11/19/2026 |
| 0.1.0-preview.35 | 43 | 11/18/2026 |
| 0.1.0-preview.34 | 51 | 11/17/2026 |
| 0.1.0-preview.33 | 60 | 11/12/2026 |
| 0.1.0-preview.32 | 110 | 11/6/2026 |
| 0.1.0-preview.31 | 282 | 10/30/2026 |
| 0.1.0-preview.30 | 65 | 10/30/2026 |
| 0.1.0-preview.29 | 64 | 10/30/2026 |
| 0.1.0-preview.28 | 90 | 10/23/2026 |
| 0.1.0-preview.27 | 129 | 10/16/2026 |
| 0.1.0-preview.26 | 87 | 10/15/2026 |
| 0.1.0-preview.25 | 95 | 10/14/2026 |
| 0.1.0-preview.24 | 68 | 10/12/2026 |
| 0.1.0-preview.23 | 75 | 10/12/2026 |
| 0.1.0-preview.22 | 92 | 10/11/2026 |
| 0.1.0-preview.21 | 123 | 9/24/2026 |
| 0.1.0-preview.20 | 63 | 9/24/2026 |
| 0.1.0-preview.19 | 143 | 9/24/2026 |
| 0.1.0-preview.18 | 87 | 9/23/2026 |