MiniPdf README

The project's README from github.com/mini-software/MiniPdf. As one markdown file: README.md.

Lightweight, fast and native Office-to-PDF libraries and command-line tools for Rust, .NET, Java, Python, JS, and Go.

NuGet crates.io Maven Central PyPI npm Go Reference GitHub stars DOI License

English | 简体中文 | 繁體中文 | 日本語 | 한국어 | Italiano | Français

Online Demo · Releases · Report an issue

Your star or donation can make MiniPdf better

🤝 Looking for co-developers: Quick contribution

MiniPdf converts Office documents directly to PDF without Microsoft Office, LibreOffice, Adobe Acrobat, or COM automation at runtime.

Choose an implementation

Implementation Inputs Interfaces Maturity Documentation Visual results
.NET XLSX, DOCX, PPTX Library, CLI, Native AOT binaries Stable .NET guide XLSX
DOCX
PPTX
Rust XLSX, DOCX, PPTX Crate, CLI Stable Rust guide XLSX
DOCX
Java XLSX, DOCX, PPTX Library, CLI Experimental Java source XLSX
DOCX
Python DOCX Package, CLI Stable Python guide XLSX
DOCX
Node.js XLSX, DOCX, PPTX Native package Stable Node.js guide XLSX
DOCX
Go XLSX, DOCX, PPTX Package, CLI Experimental Go guide XLSX

Quick start

.NET

dotnet add package MiniPdf

using MiniSoftware;

MiniPdf.ConvertToPdf("report.docx", "report.pdf");

Prefer a command-line tool?

dotnet tool install --global MiniPdf.Cli
minipdf report.docx -o report.pdf

See the .NET guide for usage.

Rust

cargo add minipdf
cargo install minipdf-cli

minipdf::convert_to_pdf("report.docx", "report.pdf")?;

minipdf report.docx -o report.pdf

See the Rust guide for usage.

Java

Maven Central artifact

import io.github.minisoftware.minipdf.MiniPdf;
import java.nio.file.Files;
import java.nio.file.Path;

try {
	MiniPdf.registerFont(
			"Noto Sans",
			Files.readAllBytes(Path.of("fonts/NotoSans-Regular.ttf")));
	MiniPdf.convertToPdf(Path.of("report.docx"), Path.of("report.pdf"));
} finally {
	MiniPdf.clearRegisteredFonts();
}

See the Java guide for usage.


```python
import minipdf

minipdf.convert_to_pdf("report.docx", "report.pdf")

See the Python guide for usage.

Node.js

npm install minipdf

const minipdf = require('minipdf')

minipdf.convertToPdf('report.docx', 'report.pdf')

See the Node.js guide for usage.

Go

go get github.com/mini-software/MiniPdf/minipdf-go@latest

import minipdf "github.com/mini-software/MiniPdf/minipdf-go"

if err := minipdf.ConvertToPDF("report.docx", "report.pdf"); err != nil {
	panic(err)
}

See the Go guide for usage.

Why MiniPdf

MiniPdf targets practical document conversion, not complete Microsoft Office layout compatibility. Complex templates may render differently; use the online demo or benchmark reports to evaluate representative files.

Quick contribution

Open a clean fork or clone in any coding agent, then paste this prompt into the agent chat:

Run the minipdf-contribution skill.

Project resources

Resource Description
Online demo Try conversion in a browser
.NET documentation Stable library and CLI usage
Rust documentation Experimental crate and CLI usage
Java implementation Experimental Maven library and CLI source
Python documentation Experimental package and CLI usage
Node.js documentation Experimental native package usage
Go documentation Experimental package and CLI usage
.NET XLSX benchmark Visual comparison results for spreadsheets
.NET DOCX benchmark Visual comparison results for documents
Rust XLSX benchmark Rust spreadsheet visual comparison results
Rust DOCX benchmark Rust document visual comparison results
Rust benchmark workflow Generate fixture coverage and comparison reports
Community governance Decisions, roles, voting, and maintainer selection
Roadmap Project scope, implementation status, and current priorities
Security Private vulnerability reporting and supported versions
Contributing Development setup, tests, reviews, and provenance requirements
GitHub releases Packages and standalone binaries
Issues Bugs, compatibility reports, and feature requests

License

Apache License 2.0. Commercial use is welcome

MiniPdf (mini-software/MiniPdf)

xlsx
Searching Database…

504 ·GitHub
MiniPdf
What is this?MiniPdf is a family of lightweight, fast, native libraries and CLI tools that convert Office documents (XLSX, DOCX, PPTX) to PDF, with implementations for .NET (C#), Rust, Java, Python, Node.js and Go.
Is this a library, a CLI, or both?Both. Each implementation ships as a library package for its ecosystem, and most also come as a command-line tool; the .NET version additionally offers standalone Native AOT binaries.
How do I convert my first document?Install the package for your language and call one function — for Node.js: 'npm install minipdf', then minipdf.convertToPdf('report.docx','report.pdf'); for Go: 'go get github.com/mini-software/MiniPdf/minipdf-go@latest'.
Do I need Microsoft Office installed for this to work?No Office stack needed — MiniPdf converts documents directly, without Microsoft Office, LibreOffice, Adobe Acrobat, or COM automation at runtime.
Which Office formats can each implementation actually convert?Input support varies: .NET covers XLSX, DOCX and PPTX; Rust and Java cover XLSX and DOCX; the Python package currently converts DOCX only — so check your format against the implementation you pick.
Can I use it in commercial software?Yes — it is Apache License 2.0, and commercial use is explicitly welcome.
Which language ports are stable and which are still experimental?.NET, Rust, Python and Node.js implementations are marked stable, while Java and Go are experimental — the Go port currently publishes verified visual results for XLSX only.
Can I try it without installing anything?Yes, the project links an online demo where you can test conversions right in the browser.
How can I check how faithful the PDF output is?The repo publishes benchmark pages with visual comparison results for XLSX and DOCX conversions in .NET and Rust, so you can inspect rendered output before committing.
What are similar projects?OfficeCLI, Filee, dsh-univer-office, anydoc, gotenberg, ReLaXed, revpdf-release, PasteMD
Which topics is it in?pdf-converter, word, xlsx, office, converter, excel, npm-package, native, document-processing, dotnet, c#, csharp
Creator
mini-software
Size
1.9 GB
Stars
504
Updated
CommitOct 15Releasejava-v0.4.0Sep 21
Age
7mo
Commits · 90 Days