Files
QuestPDF/README.md
T

93 lines
5.4 KiB
Markdown
Raw Normal View History

2022-03-12 16:38:03 +01:00
<a href="https://www.questpdf.com/" target="_blank">
2022-08-01 23:58:48 +02:00
<img src="https://github.com/QuestPDF/example-invoice/raw/main/images/logo.svg" width="400">
2021-01-16 01:41:52 +01:00
</a>
2022-02-24 19:55:36 -08:00
2023-01-06 00:47:30 +01:00
---
2023-01-04 00:34:13 +01:00
[![QuestPDF Homepage](https://img.shields.io/badge/Homepage-blue?style=for-the-badge)](https://www.questpdf.com)
2023-01-03 23:32:58 +01:00
[![Dotnet](https://img.shields.io/badge/platform-.NET-blue?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/)
[![GitHub Repo stars](https://img.shields.io/github/stars/QuestPDF/QuestPDF?style=for-the-badge)](https://github.com/QuestPDF/QuestPDF/stargazers)
[![Nuget version](https://img.shields.io/nuget/v/QuestPdf?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/)
[![Nuget download](https://img.shields.io/nuget/dt/QuestPDF?style=for-the-badge)](https://www.nuget.org/packages/QuestPDF/)
[![License](https://img.shields.io/github/license/QuestPDF/QuestPDF?style=for-the-badge)](https://github.com/QuestPDF/QuestPDF/blob/main/LICENSE)
2021-01-16 01:41:52 +01:00
<br />
2021-01-16 01:41:52 +01:00
2023-01-06 00:48:29 +01:00
### QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API.
2021-01-16 01:41:52 +01:00
2023-01-05 23:31:04 +01:00
<img src="https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/previewer/animation.gif?raw=true" width="100%">
2023-01-03 23:46:35 +01:00
2023-01-05 23:31:04 +01:00
<table>
<tr>
<td>👨‍💻</td>
<td>Design documents using C# and employ a code-only approach. Utilize your version control system to its fullest potential.</td>
</tr>
<tr>
<td>🧱</td>
<td>Compose document with a range of powerful and predictable structural elements, such as text, image, border, table, and many more.</td>
</tr>
<tr>
<td>⚙️</td>
<td>Utilize a comprehensive layout engine, specifically designed for document generation and paging support.</td>
</tr>
<tr>
<td>📖</td>
<td>Write code using concise and easy-to-understand C# Fluent API. Utilize IntelliSense to quickly discover available options.</td>
</tr>
<tr>
<td>🔗</td>
<td>Don't be limited to any proprietary scripting language or format. Follow your experience and leverage all modern C# features.</td>
</tr>
<tr>
<td>⌛</td>
<td>Save time thanks to a hot-reload capability, allowing real-time document preview without code recompilation.</td>
</tr>
</table>
2023-01-03 23:46:35 +01:00
<br />
<br />
2022-10-05 22:49:03 +02:00
## Please help by giving a star
2022-03-08 17:27:30 +01:00
2022-03-14 13:17:33 +01:00
Choosing a project dependency could be difficult. We need to ensure stability and maintainability of our projects. Surveys show that GitHub stars count play an important factor when assessing library quality.
2022-03-13 22:47:06 +01:00
2022-03-15 23:23:18 +01:00
⭐ Please give this repository a star. It takes seconds and help thousands of developers! ⭐
2022-03-13 22:47:06 +01:00
2023-01-11 22:54:23 +01:00
<img src="https://user-images.githubusercontent.com/9263853/211925834-24e80d83-dadb-41af-a7f5-522bde9c3b8f.png" width="800" />
2022-09-19 00:57:32 +02:00
2022-08-19 14:45:26 +02:00
2022-03-14 13:17:33 +01:00
## Please share with the community
As an open-source project without funding, I cannot afford advertising QuestPDF in a typical way. Instead, the library relies on community interactions. Please consider sharing a post about QuestPDF and the value it provides. It really does help!
2022-03-13 22:47:06 +01:00
2023-01-03 23:32:58 +01:00
[![Share on Reddit](https://img.shields.io/badge/share%20on-reddit-red?logo=reddit&style=for-the-badge)](https://reddit.com/submit?url=https://github.com/QuestPDF/QuestPDF&title=Check%20out%20QuestPDF%20%F0%9F%8E%8A%20a%20modern%20open-source%20.NET%20library%20%20for%20PDF%20document%20generation%20%F0%9F%9A%80)
[![Share on Twitter](https://img.shields.io/badge/share%20on-twitter-03A9F4?logo=twitter&style=for-the-badge)](https://twitter.com/share?url=https://github.com/QuestPDF/QuestPDF&text=Check%20out%20QuestPDF%20%F0%9F%8E%8A%20a%20modern%20open-source%20.NET%20library%20%20for%20PDF%20document%20generation%20%F0%9F%9A%80%20%23dotnet%20%23csharp%20%23questpdf)
[![Share on HackerNews](https://img.shields.io/badge/share%20on-hacker%20news-orange?logo=ycombinator&style=for-the-badge)](https://news.ycombinator.com/submitlink?u=https://github.com/QuestPDF/QuestPDF&t=QuestPDF%20-%20a%20modern%20open-source%20.NET%20library%20%20for%20PDF%20document%20generation)
[![Share on Facebook](https://img.shields.io/badge/share%20on-facebook-1976D2?logo=facebook&style=for-the-badge)](https://www.facebook.com/sharer/sharer.php?u=https://github.com/QuestPDF/QuestPDF)
2021-01-16 01:41:52 +01:00
<br />
2023-01-04 00:34:13 +01:00
## Let's get started
2021-03-10 19:55:58 +01:00
2023-01-03 23:58:39 +01:00
Begin exploring the QuestPDF library today. You are 250 lines of C# code away from creating a fully functional PDF invoice implementation.
2023-01-13 22:30:22 +01:00
Read the Getting Started tutorial to familiarize yourself with general library architecture, important layout structures as well as to better understand helpful patterns and practices. Easily start designing your PDF documents, reports, invoices and even more.
2023-01-03 23:58:39 +01:00
2023-01-04 00:34:13 +01:00
[![Getting started tutorial](https://img.shields.io/badge/%F0%9F%9A%80%20read-getting%20started-blue?style=for-the-badge)](https://www.questpdf.com/getting-started)
2022-03-13 22:47:06 +01:00
2022-07-27 12:21:05 +02:00
<img src="https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/invoice-small.png?raw=true" width="400px">
<br />
## QuestPDF on JetBrains OSS Power-Ups
QuestPDF was presented on one of the episodes of OSS Power-Ups hosted by JetBrains. Huge thanks for Matthias Koch and entire JetBrains team for giving me a chance to show QuestPDF. You are the best!
<a href="https://www.youtube.com/watch?v=-iYvZvpLX0g">
2022-07-27 12:21:05 +02:00
<img src="https://github.com/QuestPDF/QuestPDF-Documentation/blob/main/docs/public/jetbrains-oss-powerups-youtube.png?raw=true" width="600px">
</a>
2023-01-03 23:32:58 +01:00
[![YouTube video about QuestPDF]( https://img.shields.io/badge/watch%20on-YouTube-red?logo=youtube&style=for-the-badge)](https://www.youtube.com/watch?v=-iYvZvpLX0g)