Documentation
Edit on GitHubGuided documentation and reference links for the OfficeIMO package family.
Use guides for workflow decisions, then drop into API pages when you need type-level detail
The docs landing page is meant to answer which package or workflow you should use. Start with getting started if you are new to the suite, or jump straight into the guide family that matches the document format you need to generate, convert, or automate.
Get productive before you choose a deeper guide
These pages answer install, first-run, framework, platform, and package-selection questions for the whole OfficeIMO family.
Installation
NuGet and GalleryInstall the right .NET package or the PSWriteOffice module, and understand how the suite is split across focused libraries.
Use this first if you are deciding what to install for a new project.
Quick Start
First fileGenerate a real document quickly and use working starter examples to orient yourself before diving into larger workflows.
Use this when you want a short path from install to a successful output file.
Platform Support
Targets and AOTConfirm framework support, cross-platform expectations, and trimming or AOT guidance before you commit to a deployment model.
Use this when you are validating runtime, OS, or publish constraints.
Choose the document workflow you want to build
Each guide family starts with an overview page, then moves into focused pages for the most common authoring patterns in that package.
Word Documents
AuthoringParagraphs, tables, images, bookmarks, headers, footers, and document structure for `.docx` generation and editing.
Best for: reports, templated documents, generated letters, and rich Word layouts.
Excel Workbooks
ReportingWorksheets, tables, ranges, formulas, validation, and chart-driven spreadsheet workflows.
Best for: exports, operational reporting, and workbook generation from application data.
PowerPoint Presentations
SlidesSlide composition, shapes, text, images, charts, and repeatable deck assembly patterns.
Best for: generated status decks, slide automation, and presentation pipelines.
Markdown
Builder and ASTFluent markdown building, parser and AST concepts, HTML rendering, and content-pipeline patterns.
Best for: markdown generation, parsing pipelines, renderer hosts, and structured text workflows.
CSV
Schemas and streamingTyped CSV models, validation, schema control, headers, and stream-oriented import and export workflows.
Best for: stable CSV pipelines where structure and validation matter as much as data values.
Visio Diagrams
Shapes and connectorsPages, shapes, connectors, and diagram authoring patterns for generated `.vsdx` output.
Best for: generated diagrams, process maps, and documentation visuals.
Reader and Extraction
IngestionUnified extraction, chunking, normalization, and ingestion-oriented workflows across document inputs.
Best for: search indexing, content ingestion, and AI-oriented preprocessing stages.
Use higher-level workflows when C# package docs are not the whole story
These guides focus on PowerShell automation, document conversion, and deployment details that span more than one package.
PSWriteOffice
PowerShellCmdlets and DSL-oriented automation for Word, Excel, PowerPoint, Markdown, and CSV workflows.
Best for: scheduled reporting, GitHub Actions, and script-first document generation.
Word to HTML
ConverterBidirectional conversion between Word documents and HTML using the conversion package family.
Best for: publishing, sanitizing, or round-tripping document content to web formats.
Word to Markdown
ConverterConvert between Word and Markdown when your workflow crosses repository docs and generated Office output.
Best for: documentation pipelines, content migration, and markdown-centric exports.
Use the guided sections above when you are choosing a workflow or package family. The reference notes below are here to help when you need package feeds, repo-backed source-of-truth pointers, or a reminder of which areas still live more in code than in narrative guides.
Package Feeds
- Core builders: OfficeIMO.Word on NuGet, OfficeIMO.Excel on NuGet, OfficeIMO.PowerPoint on NuGet, OfficeIMO.Markdown on NuGet, OfficeIMO.CSV on NuGet, OfficeIMO.Visio on NuGet
- Workflow and conversion packages: OfficeIMO.Reader on NuGet, OfficeIMO.Word.Html on NuGet, OfficeIMO.Word.Markdown on NuGet
- PowerShell automation: PSWriteOffice on PowerShell Gallery
When the Guides End
This site gives the best narrative coverage to the packages most teams start with:
OfficeIMO.WordOfficeIMO.ExcelOfficeIMO.PowerPointOfficeIMO.MarkdownOfficeIMO.CSVOfficeIMO.ReaderPSWriteOffice
The repo also includes adjacent packages such as OfficeIMO.Word.Pdf, OfficeIMO.Word.Html, OfficeIMO.Word.Markdown, OfficeIMO.Visio, specialized reader extensions, and renderer projects. Some of those are linked from the package feeds below and the API reference, but not all of them have full narrative guides on the website yet. When a package is not fully covered here, the most accurate sources are usually:
- the package README in the repo,
- the generated API reference,
- the example projects under
OfficeIMO.Examples, - and the test suite for current behavior.
Fast Reference
- Installation for package/module install commands.
- Quick Start for a first successful output file.
- Platform Support for frameworks, OS expectations, and AOT notes.
- AOT and Trimming for deployment-sensitive workloads.
- PSWriteOffice Docs for script-first automation.
- API Reference when you already know the package and need type-level details.
License
OfficeIMO is licensed under the MIT License. Copyright (c) Przemyslaw Klys @ Evotec. If you need to review upstream runtime dependencies such as Open XML SDK, ImageSharp, or QuestPDF, see the Third-Party Dependencies page.
Source Code
The full source code is available on GitHub: https://github.com/EvotecIT/OfficeIMO