Skip to content

Commit e65e1ca

Browse files
committed
amend
1 parent ae8e9fb commit e65e1ca

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ htmldocs is a local document editor and preview server to help you _create_ PDFs
2222
- ⚡ Dynamic data integration through props and APIs
2323
- 📊 Real-time preview server with hot reloading
2424

25-
## 💡 Example
25+
## Example
2626

2727
To see the full power of htmldocs, here is how you might build a dynamic invoice document template with JSX template variables:
2828

@@ -44,13 +44,13 @@ To change the customer details, all you need to do is render the `Invoice` compo
4444
/>
4545
```
4646

47-
## 🎨 Editor
47+
## Screenshots
4848

4949
![Resume example](https://github.com/user-attachments/assets/24eabc4a-ec9e-43de-a2a0-00bcde55985a)
5050

5151
![Variables editor](https://github.com/user-attachments/assets/d16658ea-4d53-4dc2-8c74-696012c4ce9b)
5252

53-
## 📥 Install
53+
## Install
5454

5555
To create your first htmldocs project, run the following command:
5656

@@ -60,7 +60,7 @@ npx htmldocs@latest init
6060

6161
For further instructions or to integrate htmldocs into your existing project, refer to the [Getting Started](https://docs.htmldocs.com/getting-started) guide.
6262

63-
## 🧩 Components
63+
## Components
6464

6565
htmldocs comes with a standard set of components to help you layout and style your documents.
6666

@@ -71,13 +71,13 @@ htmldocs comes with a standard set of components to help you layout and style yo
7171
- [MarginBox](https://docs.htmldocs.com/components/margin-box)
7272
- [Spacer](https://docs.htmldocs.com/components/spacer)
7373

74-
## ⚙️ How it works
74+
## How it works
7575

7676
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.
7777

7878
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.
7979

80-
## 📊 Comparison
80+
## Comparison
8181

8282
| Feature | Traditional Documents<br/>(Word, Google Docs) | LaTeX Documents<br/>(Overleaf, TeXStudio) | Freeform Documents<br/>(Figma, Sketch) | Web Documents<br/>(htmldocs) |
8383
|---------|:-------------------------------------------:|:----------------------------------------:|:-------------------------------------:|:---------------------------:|
@@ -93,12 +93,12 @@ htmldocs also uses the [Paged.js library](https://pagedjs.org/) under the hood.
9393
| Type Safety | ❌ Limited | ❌ Limited | ❌ Limited | ✅ Supported |
9494
| AI | ❌ Limited | ❌ Limited | ❌ Limited | ✅ Supported |
9595

96-
## 🛠️ Tech Stack
96+
## Tech Stack
9797

9898
| <img src="https://github.com/user-attachments/assets/df03494d-44a1-4a74-9ae6-1ee9870c2ce2" width="48px" height="48px" alt="Next.js"> | <img src="https://www.typescriptlang.org/favicon-32x32.png" width="48px" height="48px" alt="TypeScript"> | <img src="https://user-images.githubusercontent.com/4060187/196936123-f6e1db90-784d-4174-b774-92502b718836.png" width="48px" height="48px" alt="Turborepo"> | <img src="https://pnpm.io/img/favicon.png" width="48px" height="48px" alt="pnpm"> |
9999
|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
100100
| Next.js | TypeScript | Turborepo | pnpm |
101101

102-
## 📄 License
102+
## License
103103

104104
MIT License

0 commit comments

Comments
 (0)