OfficeIMO.Markdown.Pdf 3.6.1

OfficeIMO.Markdown.Pdf - Markdown to PDF export

OfficeIMO.Markdown.Pdf exports OfficeIMO.Markdown documents to PDF through the first-party OfficeIMO.Pdf engine. It is a thin adapter: Markdown parsing stays in OfficeIMO.Markdown, and PDF layout/writing stays in OfficeIMO.Pdf.

Internal links resolve heading anchors, generic block identifiers and supported inline anchor carriers. Destinations follow the rendered block; identifiers inside flattened table or list-item content target that render unit. Missing targets retain visible link text and add an UnresolvedInternalLink warning to the conversion report.

Install

dotnet add package OfficeIMO.Markdown.Pdf

Quick start

using OfficeIMO.Markdown;
using OfficeIMO.Markdown.Pdf;

MarkdownDocument document = MarkdownDocument.Parse("""
# Status

This is **important** and includes [OfficeIMO](https://github.com/EvotecIT/OfficeIMO).

| Area | State |
| --- | --- |
| PDF | Native |
""");

document.SaveAsPdf("status.pdf");

Raw Markdown text uses source-explicit names so it cannot be confused with HTML or RTF strings:

using OfficeIMO.Markdown.Pdf;

using var document = OfficeIMO.Markdown.MarkdownDocument.Parse("# Hello\n\nGenerated by OfficeIMO.");
document.SaveAsPdf("hello.pdf");

File-based conversion uses the native Markdown lifecycle so a string path is not confused with Markdown text:

MarkdownDocument.Load("README.md").SaveAsPdf("README.pdf");

Code, notes, and multilingual text

Fenced code retains leading and repeated spaces and tabs. Inline code and fenced code select Courier and share the configured monospace fallbacks. Footnote references are superscript links to definitions collected at the end of the document.

Default text fallbacks include installed multilingual fonts. Their availability and ResourcePolicy.AllowSystemFontEmbedding govern character coverage; TextFallbacks = PdfTextFallbackFeatures.None selects exact standard-font output.

Page images

Export PNG, JPEG, or SVG from the converted PDF document so images use its pagination, fonts, and layout:

using OfficeIMO.Pdf;

using var pdf = document.ToPdf(null, out OfficeIMO.OfficeConversionReport conversionReport);
pdf.SaveAsImages("pages");
pdf.SaveAsImages("jpeg-pages", new PdfImageExportOptions { Format = OfficeIMO.Drawing.OfficeImageExportFormat.Jpeg });
pdf.SaveAsImages("svg-pages", new PdfImageExportOptions { Format = OfficeIMO.Drawing.OfficeImageExportFormat.Svg });

SVG follows the PDF page renderer's vector and embedded-raster contract. Inspect the conversion report before rendering pages; each image export report contains rendering diagnostics.

Examples

Use front matter for metadata and theme selection

using OfficeIMO.Markdown.Pdf;

string markdown = """
---
title: Incident review
author: Operations
pdfTheme: TechnicalDocument
tags:
  - incident
  - review
---

# Incident review

## Summary

- Detection was automatic.
- Customer impact was limited.
- Follow-up tasks are tracked below.

| Task | Owner |
| --- | --- |
| Update monitor | Platform |
| Review runbook | Operations |
""";

OfficeIMO.Markdown.MarkdownDocument.Parse(markdown).SaveAsPdf("incident-review.pdf", new MarkdownPdfExportOptions {
    UseFrontMatterMetadata = true,
    UseFrontMatterTheme = true,
    FrontMatterRenderMode = MarkdownPdfFrontMatterRenderMode.DocumentHeader
});

Convert a Markdown file with local images

using OfficeIMO.Markdown.Pdf;
using OfficeIMO.Pdf;

var options = new MarkdownPdfExportOptions {
    BaseDirectory = Path.GetDirectoryName(Path.GetFullPath("Docs/status.md")),
    IncludeImages = true,
    ResourcePolicy = PdfResourcePolicy.CreateTrustedHost(),
    DefaultImageWidth = OfficeIMO.OfficeLength.Points(420),
    DefaultImageHeight = OfficeIMO.OfficeLength.Points(240),
    Theme = OfficeIMO.Markdown.MarkdownVisualTheme.Report()
};

MarkdownDocument.Load("Docs/status.md").SaveAsPdf("Artifacts/status.pdf", options);

Reuse one visual theme across HTML, PDF, and Word

using OfficeIMO;
using OfficeIMO.Markdown;
using OfficeIMO.Markdown.Pdf;
using OfficeIMO.Word.Markdown;

MarkdownVisualTheme theme = MarkdownVisualTheme.FromOfficeTheme(OfficeTheme.Boardroom)
    .WithColorScheme(MarkdownColorSchemeKind.Emerald)
    .WithColors(accent: "SeaGreen", heading: "#064e3b")
    .WithTable(table => {
        table.BorderWidth = OfficeLength.Points(0.9);
        table.CellPaddingX = OfficeLength.Points(8);
        table.UseRowStripes = true;
    });

using MarkdownDocument document = MarkdownDocument.Parse(markdown);

document.SaveAsHtml("report.html", new MarkdownHtmlExportOptions { Theme = theme });
document.SaveAsPdf("report.pdf", new MarkdownPdfExportOptions { Theme = theme });

using var word = document.ToWord(new MarkdownWordExportOptions { Theme = theme });
word.Save("report.docx");

FromOfficeTheme carries the shared fonts, type scale, colors, spacing, page margins and table defaults into each adapter. Format-specific options and authored emphasis, code and links retain their supported meaning. Plain conversion keeps its existing defaults until a theme is selected. Arbitrary inline CSS in Markdown is handled by the HTML engine rather than the direct Word and PDF adapters.

Write to bytes or streams

using OfficeIMO.Markdown;
using OfficeIMO.Markdown.Pdf;

MarkdownDocument document = MarkdownDocument.Parse("# Invoice notes\n\nGenerated by OfficeIMO.");

using var pdf = document.ToPdf();
byte[] pdfBytes = pdf.ToBytes(new OfficeIMO.Pdf.PdfSaveOptions { AllowLoss = true });

using var stream = File.Create("invoice-notes.pdf");
document.SaveAsPdf(stream);

Keep warnings visible

using OfficeIMO.Markdown.Pdf;
using OfficeIMO.Pdf;

var options = new MarkdownPdfExportOptions {
    RemoteImageResolver = null,
    IncludeImages = true
}.UseProfile(PdfExportProfile.Faithful);

options.TextFallbacks = PdfTextFallbackFeatures.Default;

MarkdownDocument document = MarkdownDocument.Load("README.md");
OfficeIMO.OfficeConversionReport report = document.SaveAsPdf("README.pdf", options);
foreach (OfficeIMO.OfficeDiagnostic diagnostic in report.Diagnostics) {
    Console.WriteLine($"{diagnostic.Code}: {diagnostic.Message}");
}
report.ThrowIfLoss();

What it maps

• Headings with bookmark anchors and PDF outlines.
• PDF metadata from options, YAML front matter, or the first heading.
• Paragraphs, rich inline formatting, links, lists, task lists, tables, code blocks, semantic fenced blocks, callouts, details, definition lists, block quotes, footnotes, and generated table-of-contents blocks.
• Visual themes for readable document rhythm, page treatment, links, code blocks, panels, tables, and checklist rows.
• Profile presets through MarkdownPdfExportOptions.UseProfile(...), plus shared TextFallbacks and ResourcePolicy controls. Profiles may disable images for lightweight/text-only output but never grant local, remote, or host-font access.
• IncludeImages controls whether images participate at all. PdfResourcePolicy is the only trust gate for local files, data URIs, remote resolvers, and installed host fonts. Local-image containment resolves symlinks and junctions before reading.
• PdfTextFallbackFeatures.MultilingualFonts, included in Default, selects multilingual fallback families. The balanced default permits installed-font discovery without granting local-file or remote-resource access; use PdfResourcePolicy.CreatePortableDeterministic() when host fonts must not be inspected.
• Per-operation diagnostics through OfficeConversionReport.

Visual themes

Conversion uses plain table formatting and authored column alignment by default. Pass Theme, set ApplyDefaultTheme = true, or select a styled export profile to add presentation styling. An explicit Style.TableStyle.RightAlignNumeric can infer numeric alignment when that is wanted.

var options = new MarkdownPdfExportOptions {
    Theme = OfficeIMO.Markdown.MarkdownVisualTheme.TechnicalDocument()
};

MarkdownDocument.Load("README.md").SaveAsPdf("README.pdf", options);

Built-in themes include Plain, WordLike, TechnicalDocument, GitHubLike, Compact, and Report. Front matter can select a theme with pdfTheme or pdf-theme.

MarkdownVisualTheme is the shared cross-format theme object. It accepts color schemes plus individual color overrides using either hex values such as #064e3b or OfficeIMO-style named colors such as SeaGreen and CornflowerBlue. MarkdownPdfStyle remains available when PDF-only details such as page decoration or low-level panel styles need to diverge.

Boundaries

• Markdown parsing and writing stay in OfficeIMO.Markdown.
• PDF layout and primitives stay in OfficeIMO.Pdf.
• This package maps Markdown structure to PDF structure and visual themes.
• Large visual-state inventories belong in deeper docs and tests, not this README.

Related packages

• OfficeIMO.Markdown - Markdown document model.
• OfficeIMO.Pdf - PDF engine.
• OfficeIMO.Html.Pdf - HTML/PDF bridge.

Targets and license

• Targets: netstandard2.0, net8.0, net10.0.
• License: MIT.
• Repository: EvotecIT/OfficeIMO

Dependency footprint

• External: None beyond the dependencies of its OfficeIMO format packages.
• OfficeIMO: OfficeIMO.Markdown, OfficeIMO.Pdf, and OfficeIMO.Core own parsing, themes, layout, rendering, and reports.

See the complete OfficeIMO package map for related formats and conversion paths.

Generated capability summary

This table is generated from the package-neutral OfficeIMO operation catalog. The detailed source contracts remain authoritative for feature-level behavior and limitations.

The complete rows for OfficeIMO.Markdown.Pdf are published in the generated operation contract.