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: docs/Advanced Configuration/UI Customisation.md
+28-63Lines changed: 28 additions & 63 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,62 +20,34 @@ These settings (in Settings.yml) control system behavior and customization capab
20
20
-`showUpdate` - Controls whether update notifications are displayed
21
21
-`showUpdateOnlyAdmin` - When true, restricts update notifications to admin users only (requires `showUpdate: true`)
22
22
23
-
24
-
## System Configuration
25
-
``customHTMLFiles`` In Settings.yml Enables custom HTML file overrides (called fragments) when set to true
26
-
27
-
## Custom Files
28
-
When `customHTMLFiles` is enabled, you can override the default templatesby placing your custom files in specific directories. The system uses a resource override mechanism where files in these custom directories take precedence over the default files.
**Important**: Stirling-PDF V2.0 uses a React-based frontend. The V1.5 `customFiles/` folder system for overriding templates **no longer works** in V2.0.
26
+
27
+
For advanced UI customization in V2.0:
28
+
1. Clone or download the repository
29
+
2. Modify the React components in the `frontend/src` directory
30
+
3. Build the frontend: `cd frontend && npm install && npm run build`
31
+
4. Volume mount the `frontend/dist` folder into your Docker container to replace the built-in frontend files
To override existing files, maintain the same directory structure as the original. Here are some examples with links to the original files you would be overriding:
46
-
47
-
To override a file:
48
-
1. Navigate to the original file in the GitHub repository
49
-
2. Copy its contents
50
-
3. Create the same file path under your `customFiles` directory following the same directory structure
51
-
4. Paste and modify the contents as needed
52
-
53
-
Note: When overriding templates, first copy the existing template from the [source repository](https://github.com/Stirling-Tools/Stirling-PDF/tree/main/app/core/src/main/resources/templates) to maintain the base structure.
54
-
55
-
1. To replace the favicon:
56
-
```
57
-
customFiles/static/favicon.svg
58
-
```
59
-
Original file: [Stirling-PDF/app/core/src/main/resources/static/favicon.svg](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/app/core/src/main/resources/static/favicon.svg)
60
-
61
-
2. To override a Bootstrap icon font:
62
-
```
63
-
customFiles/static/css/fonts/bootstrap-icons.woff
64
-
```
65
-
Original file: [Stirling-PDF/app/core/src/main/resources/static/css/fonts/bootstrap-icons.woff](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/app/core/src/main/resources/static/css/fonts/bootstrap-icons.woff)
66
-
67
-
3. To modify a template:
68
-
```
69
-
customFiles/templates/fragments/common.html
70
-
```
71
-
Original file: [Stirling-PDF/app/core/src/main/resources/templates/fragments/common.html](https://github.com/Stirling-Tools/Stirling-PDF/blob/main/app/core/src/main/resources/templates/fragments/common.html)
72
-
73
-
The original files can be found in the GitHub repository under:
Copy file name to clipboardExpand all lines: docs/Functionality/The Technologies.md
+19-15Lines changed: 19 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,25 +5,29 @@ description: List of all technologies Stirling-PDF uses!
5
5
# The Technologies Behind Stirling PDF
6
6
Stirling PDF harnesses several technologies throughout its implementation.
7
7
8
-
# Java
9
-
As part of the JAVA framework to host the WebUI itself we use Spring Boot and Thymeleaf.
10
-
Apache PDFBox is the core of the PDF functionality within Stirling-PDF.
11
-
They offer a variety of methods to edit PDFs which we have then built Stirling-PDF on.
12
-
We also show all licenses used within our Java application [here](https://stirlingpdf.io/licenses).
13
-
14
-
# JavaScript
15
-
-[PDF.js](https://github.com/mozilla/pdf.js)
16
-
-[PDF-LIB.js](https://github.com/Hopding/pdf-lib)
17
-
18
-
# Core Components
19
-
-[Spring Boot + Thymeleaf](https://spring.io/projects/spring-boot) for the web framework
8
+
# Backend (Java)
9
+
-[Spring Boot](https://spring.io/projects/spring-boot) for the REST API framework
20
10
-[PDFBox](https://pdfbox.apache.org/) for majority of PDF manipulation
21
11
-[qpdf](https://qpdf.sourceforge.io/) for some PDF operations
22
12
-[LibreOffice](https://www.libreoffice.org/discover/libreoffice/) for advanced file conversions
23
13
24
-
# Additional Technologies
25
-
- HTML, CSS, JavaScript for the frontend
14
+
We also show all licenses used within our Java application [here](https://stirlingpdf.io/licenses).
15
+
16
+
# Frontend (React SPA)
17
+
-[React](https://react.dev/) + [TypeScript](https://www.typescriptlang.org/) for the web application
18
+
-[Vite](https://vitejs.dev/) for build tooling and development server
19
+
-[Mantine UI](https://mantine.dev/) component library for UI components
20
+
-[TailwindCSS](https://tailwindcss.com/) for styling
21
+
-[PDF.js](https://github.com/mozilla/pdf.js) for client-side PDF rendering
22
+
-[PDF-LIB.js](https://github.com/Hopding/pdf-lib) for client-side PDF manipulation
23
+
-[IndexedDB](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API) for client-side file storage and caching
24
+
-[i18next](https://www.i18next.com/) for internationalization
25
+
26
+
# Desktop Application
27
+
-[Tauri](https://tauri.app/) for native desktop application framework (Windows, Mac, Linux)
28
+
29
+
# Infrastructure
26
30
- Docker for containerization
27
-
-jcefmaven (specifically for portable non-server version)
31
+
-Gradle for build management
28
32
29
33
For a comprehensive list of all technologies within the java application and their licenses, please visit our [licenses page](https://stirlingpdf.io/licenses).
Copy file name to clipboardExpand all lines: docs/Getting Started.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,10 +13,18 @@ slug: /
13
13
-**Open-Source:** Community-driven with frequent updates and GitHub support.
14
14
-**Multi-Language Support:** Available in 38+ languages with active translations.
15
15
16
+
### What's New in V2.0
17
+
-**Modern React Frontend:** Complete rewrite with React + TypeScript for improved performance and user experience
18
+
-**Stateful Document Processing:** Upload PDFs once and chain multiple tools without reloading
19
+
-**Enhanced Performance:** Handles large PDFs (up to 100GB+) with improved memory management
20
+
-**Client-Side File Storage:** IndexedDB for persistent file storage and thumbnail caching
21
+
-**Improved Desktop Experience:** Native desktop apps powered by Tauri
22
+
-**Flexible Deployment:** Separate frontend/backend deployment options for scalability
23
+
16
24
Please feel free to request new features or report bugs through our [GitHub](https://github.com/Stirling-Tools/Stirling-PDF/issues) or [Discord](https://discord.gg/Cn8pWhQRxZ).
17
25
18
26
19
-
## Introduction
27
+
## Introduction
20
28
21
29
This guide will help you choose the right installation method based on your needs.
22
30
We prioritise and focus on our Server deployment options however we also offer a [Ultra-Lite model](/Installation/Versions) for desktop users
0 commit comments