questpdf / questpdf-documentation Goto Github PK

License: MIT License

questpdf-documentation's Introduction

QuestPDF is a modern open-source .NET library for PDF document generation. Offering comprehensive layout engine powered by concise and discoverable C# Fluent API.

👨‍💻	Design PDF documents using C# and employ a code-only approach. Utilize your version control system to its fullest potential.
🧱	Compose PDF document with a range of powerful and predictable structural elements, such as text, image, border, table, and many more.
⚙️	Utilize a comprehensive layout engine, specifically designed for PDF document generation and paging support.
📖	Write code using concise and easy-to-understand C# Fluent API. Utilize IntelliSense to quickly discover available options.
🔗	Don't be limited to any proprietary scripting language or format. Follow your experience and leverage all modern C# features.
⌛	Save time thanks to a hot-reload capability, allowing real-time PDF document preview without code recompilation.

Please help by giving a star

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.

⭐ Please give this repository a star. It takes seconds and help thousands of developers! ⭐

QuestPDF Companion App (preview)

The QuestPDF Companion application is a tool designed to simplify and speed up your development lifecycle. First, it shows a preview of your document. But the real magic starts with the hot-reload capability! It observes your code and updates the preview every time you change the implementation. Get real-time results without the need of code recompilation. Save time and enjoy the task!

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!

Let's get started

Begin exploring the QuestPDF library today. You are 250 lines of C# code away from creating a fully functional PDF invoice implementation.

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.

Library License

We identify the importance of the library in your projects, so we want to ensure you can safely and confidently continue the development.

Being a healthy and growing community is the primary goal that motivates us to pursue professionalism.

The library is available for free to the vast majority of users. However, please look at the QuestPDF License and Pricing webpage for more details:

QuestPDF on YouTube

We are incredibly grateful to the YouTube Community for their positive reviews and recommendations of the QuestPDF library. Your support and feedback are invaluable and motivate us to keep improving and expanding this project. Thank you for helping us grow and reach more developers!

Nick Chapsas: The Easiest Way to Create PDFs in .NET

Claudio Bernasconi: QuestPDF - The BEST PDF Generator for .NET?!

JetBrains: OSS Power-Ups: QuestPDF

Programming with Felipe Gavilan: Generating PDFs with C# - Very Easy (two examples)

questpdf-documentation's People

Contributors

Stargazers

Watchers

Forkers

darshanrampatel tvde1 jordansrowles jz5 scarso327 robertmiles3 ducki enricobenedos thomasstevens89 antonycorbett trevorjobling atikhan bennetbo jerone wasimahmad viranka comedgaji

questpdf-documentation's Issues

Broken link to getting started

Go to https://www.questpdf.com/quick-start

The following link gives a 404 at links to .html
Read <a href="[/getting-started.html](https://www.questpdf.com/getting-started.html)">the Getting started tutorial</a> to learn

404 error "sticks"

After visiting a page that does not exist and recieving a 404 error, navigating to another page shows the content below but does not remove the error:

Improving the documentation

Hi,

I saw on your roadmap that you'd like to work on a documentation redesign to help new developers and simplify the learning process Well, as a new developer that's interested in getting better with QuestPDF (and .NET in general), I'd like to help you out. I used QuestPDF in a project that creates randomly generated math worksheets for kids. While I was working on it, I heavily relied on your current documentation to get me through the PDF generation process. It helped me a lot, but I agree that it could use a bit of an overhaul.

I've taken a couple of technical writing classes in my day, but I've never contributed to open source before. Let me know what I can do to help.

Thanks,
Spencer

Build and run docs locally?

I work in an "air gapped" environment, and would like to be able to run/host the docs locally.

The readme does not seem to mention how to build the docs (just looked quickly).

Please point me to the building/hosting instructions or please give me a brief explanation of the process.

Thanks!!! :)

Instructions/Documentation for Blazor/WASM

The link for the example at https://github.com/pablopioli/Blazor-QuestPDF is deader than dillinger.

Hyperlink api-reference code sample not correct

Code sample in https://www.questpdf.com/api-reference/hyperlink.html seems to be referring old code .Hyperlink(string), while code in https://www.questpdf.com/api-reference/text.html#hyperlink is working fine Hyperlink(string, string).

"Show once" images have an incorrect title

The second set of images in the Show once examples mention "With show once".

It seems that these images should mention "Without show once" based on the example displayed in them.

How can I contribue Chinese version of documents?

I'd like to contribute Chinese version of documents.
What should I do? Can I create a ***_ZH_CN.md, for example, Readme_ZH_CN.md?

Why Process.Start() twice?

New to PDF processing and found this magnificent library! When read through the getting started section, notice that in the document generation section's sample code Process.Start() are called twice. Just out of curiosity, is there any reason behind this?

Getting virus detected on downloaded documentation

This is on Windows 11. It says it's severe and is Trojan:Script/Wacatac.B!ml, I get this warning any time I download the file QuestPDF-Documentation-main.zip. It gets zapped. I'll download files using Git instead and see if it still occurs.