You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/htmldocs/README.md
+24-8
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,7 @@
11
11
12
12
PDF document creation is stuck in the past, from clunky Word docs to complex LaTeX to outdated tools. htmldocs brings document generation into 2025 with a modern developer experience using the tools you already love: **React**, **TypeScript**, and **Tailwind**.
13
13
14
-
## 🚀 What is htmldocs?
14
+
## What is htmldocs?
15
15
16
16
htmldocs is a local document editor and preview server to help you _create_ PDFs with React. It provides all the structural benefits of LaTeX with the familiarity of HTML and CSS. With htmldocs, you can use JSX to build document templates (invoices, reports, contracts, etc.) and generate PDFs just by passing data as props. htmldocs has:
17
17
@@ -22,7 +22,7 @@ htmldocs is a local document editor and preview server to help you _create_ PDFs
22
22
- ⚡ Dynamic data integration through props and APIs
23
23
- 📊 Real-time preview server with hot reloading
24
24
25
-
## 💡 Example
25
+
## Example
26
26
27
27
To see the full power of htmldocs, here is how you might build a dynamic invoice document template with JSX template variables:
28
28
@@ -44,13 +44,13 @@ To change the customer details, all you need to do is render the `Invoice` compo
To create your first htmldocs project, run the following command:
56
56
@@ -60,7 +60,7 @@ npx htmldocs@latest init
60
60
61
61
For further instructions or to integrate htmldocs into your existing project, refer to the [Getting Started](https://docs.htmldocs.com/getting-started) guide.
62
62
63
-
## 🧩 Components
63
+
## Components
64
64
65
65
htmldocs comes with a standard set of components to help you layout and style your documents.
66
66
@@ -71,18 +71,34 @@ htmldocs comes with a standard set of components to help you layout and style yo
htmldocs is built upon Chromium's rendering engine, which means it can render any HTML, CSS, and JavaScript. This is different from other tools like [wkhtmltopdf](https://wkhtmltopdf.org/), [WeasyPrint](https://weasyprint.org/), and [Prince](https://www.princexml.com/), which only support a subset of HTML and CSS.
77
77
78
78
htmldocs also uses the [Paged.js library](https://pagedjs.org/) under the hood. Paged.js is used for layout and chunking, as well as more modern features like margin boxes that aren't fully supported by the W3C's CSS standard.
79
79
80
-
## 🛠️ Tech Stack
80
+
## Comparison
81
+
82
+
| Feature | Traditional Documents<br/>(Word, Google Docs) | LaTeX Documents<br/>(Overleaf, TeXStudio) | Freeform Documents<br/>(Figma, Sketch) | Web Documents<br/>(htmldocs) |
0 commit comments