feat: Add VitePress docs, EPUB to PDF tool, Phosphor icons, and licensing updates
- Set up VitePress documentation site (docs:dev, docs:build, docs:preview) - Added Getting Started, Tools Reference, Contributing, and Commercial License pages - Created self-hosting guides for Docker, Vercel, Netlify, Cloudflare, AWS, Hostinger, Nginx, Apache - Updated README with documentation link, sponsors section, and docs contribution guide - Added EPUB to PDF converter using LibreOffice WASM - Migrated to Phosphor Icons for consistent iconography - Added donation ribbon banner on landing page - Removed 'Like My Work?' section (replaced by ribbon) - Updated licensing.html with delivery model, AGPL notice, invoicing, and no-refund policy - Added Commercial License documentation page - Updated translations table (Chinese added, marked non-English as In Progress) - Added sponsors.yml workflow for auto-generating sponsor avatars
This commit is contained in:
abdullahalam123
94
README.md
94
README.md
@@ -3,7 +3,7 @@
|
||||
|
||||
**BentoPDF** is a powerful, privacy-first, client-side PDF toolkit that is self hostable and allows you to manipulate, edit, merge, and process PDF files directly in your browser. No server-side processing is required, ensuring your files remain secure and private.
|
||||
|
||||
 [](https://ko-fi.com/alio0) 
|
||||
 [](https://ko-fi.com/alio01) 
|
||||
[](https://github.com/sponsors/alam00000)
|
||||
|
||||
|
||||
@@ -18,6 +18,19 @@ Have questions, feature requests, or want to chat with the community? Join our D
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
[](https://bentopdf.com/docs/)
|
||||
|
||||
Visit our [Documentation](https://bentopdf.com/docs/) for:
|
||||
- **Getting Started** guide
|
||||
- **Tools Reference** (50+ tools)
|
||||
- **Self-Hosting** guides (Docker, Vercel, Netlify, Cloudflare, AWS, Hostinger, Nginx, Apache)
|
||||
- **Contributing** guide
|
||||
- **Commercial License** details
|
||||
|
||||
---
|
||||
|
||||
## 📜 Licensing
|
||||
|
||||
BentoPDF is dual-licensed:
|
||||
@@ -35,6 +48,18 @@ For more details, see our [Licensing Page](https://bentopdf.com/licensing.html)
|
||||
|
||||
---
|
||||
|
||||
## 💖 Thank You to Our Sponsors
|
||||
|
||||
We're incredibly grateful to all our sponsors and supporters who help keep BentoPDF free and open source!
|
||||
|
||||
[](https://github.com/sponsors/alam00000)
|
||||
[](https://ko-fi.com/alio01)
|
||||
|
||||
<!-- sponsors -->
|
||||
<!-- sponsors -->
|
||||
|
||||
---
|
||||
|
||||
## ✨ Why BentoPDF?
|
||||
|
||||
- **Privacy First**: All processing happens in your browser. Your files are never uploaded to a server, guaranteeing 100% privacy.
|
||||
@@ -110,6 +135,7 @@ BentoPDF offers a comprehensive suite of tools to handle all your PDF needs.
|
||||
| **TIFF to PDF** | Convert TIFF images to PDF. |
|
||||
| **Markdown to PDF** | Convert `.md` files into professional PDF documents. |
|
||||
| **Text to PDF** | Convert plain text files into a PDF. |
|
||||
| **EPUB to PDF** | Convert EPUB e-books to PDF format. |
|
||||
| **JSON to PDF** | Convert JSON to PDF. |
|
||||
|
||||
### Convert from PDF
|
||||
@@ -151,11 +177,12 @@ BentoPDF offers a comprehensive suite of tools to handle all your PDF needs.
|
||||
|
||||
BentoPDF is available in multiple languages:
|
||||
|
||||
| Language | Status |
|
||||
|----------|--------|
|
||||
| English | [](public/locales/en/common.json) |
|
||||
| German | [](public/locales/de/common.json) |
|
||||
| Vietnamese | [](public/locales/vi/common.json) |
|
||||
| Language | Status |
|
||||
|------------|--------|
|
||||
| English | [](public/locales/en/common.json) |
|
||||
| German | [](public/locales/de/common.json) |
|
||||
| Vietnamese | [](public/locales/vi/common.json) |
|
||||
| Chinese | [](public/locales/zh/common.json) |
|
||||
|
||||
Want to help translate BentoPDF into your language? Check out our [Translation Guide](TRANSLATION.md)!
|
||||
|
||||
@@ -252,6 +279,35 @@ npm run preview
|
||||
|
||||
```
|
||||
|
||||
**Compression Modes:**
|
||||
|
||||
BentoPDF supports different compression modes for optimized builds:
|
||||
|
||||
```bash
|
||||
# Gzip only (smallest Docker image size)
|
||||
npm run build:gzip
|
||||
docker build --build-arg COMPRESSION_MODE=g -t bentopdf:gzip .
|
||||
|
||||
# Brotli only (best compression ratio)
|
||||
npm run build:brotli
|
||||
docker build --build-arg COMPRESSION_MODE=b -t bentopdf:brotli .
|
||||
|
||||
# No compression (fastest build time)
|
||||
npm run build:original
|
||||
docker build --build-arg COMPRESSION_MODE=o -t bentopdf:original .
|
||||
|
||||
# All formats (default, maximum browser compatibility)
|
||||
npm run build:all
|
||||
docker build --build-arg COMPRESSION_MODE=all -t bentopdf:all .
|
||||
```
|
||||
|
||||
| Mode | Files Kept | Use Case |
|
||||
|------|------------|----------|
|
||||
| `g` | `.gz` only | Standard nginx or minimal size |
|
||||
| `b` | `.br` only | Modern CDN with Brotli support |
|
||||
| `o` | originals | Development or custom compression |
|
||||
| `all` | all formats | Maximum compatibility (default) |
|
||||
|
||||
**Subdirectory Hosting:**
|
||||
|
||||
BentoPDF can also be hosted from a subdirectory (e.g., `example.com/tools/bentopdf/`):
|
||||
@@ -480,6 +536,32 @@ We welcome contributions from the community! Here's how you can get started:
|
||||
|
||||
Have an idea for a new tool or an improvement? [Open an issue](https://github.com/alam00000/bentopdf/issues) to discuss it first.
|
||||
|
||||
### 📖 Contributing to Documentation
|
||||
|
||||
Our documentation is built with [VitePress](https://vitepress.dev/). Here's how to contribute:
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Start docs dev server
|
||||
npm run docs:dev
|
||||
|
||||
# Build docs for production
|
||||
npm run docs:build
|
||||
|
||||
# Preview the built docs
|
||||
npm run docs:preview
|
||||
```
|
||||
|
||||
Documentation files are in the `docs/` folder:
|
||||
- `docs/index.md` - Home page
|
||||
- `docs/getting-started.md` - Getting started guide
|
||||
- `docs/tools/` - Tools reference
|
||||
- `docs/self-hosting/` - Self-hosting guides (Docker, Vercel, Netlify, Hostinger, etc.)
|
||||
- `docs/contributing.md` - Contributing guide
|
||||
- `docs/licensing.md` - Commercial license info
|
||||
|
||||
---
|
||||
|
||||
## Special Thanks
|
||||
|
||||
Reference in New Issue
Block a user