Skip to content

Commit

Permalink
move docs around change get started
Browse files Browse the repository at this point in the history
  • Loading branch information
Frooodle committed Dec 19, 2024
1 parent 781a785 commit af97906
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 101 deletions.
21 changes: 0 additions & 21 deletions About.md

This file was deleted.

21 changes: 0 additions & 21 deletions Contact.md

This file was deleted.

21 changes: 0 additions & 21 deletions Demo.md

This file was deleted.

28 changes: 21 additions & 7 deletions docs/Overview/Getting Started.md → docs/Getting Started.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,24 @@
---
sidebar_position: 1
sidebar_position: 0
slug: /
---
# Getting Started with Stirling PDF

Welcome to Stirling PDF! This guide will help you choose the right installation method based on your needs.
## Benefits of Stirling-PDF
- **Extensive PDF Functionality:** Access 50+ tools, including signing, converting, merging, and more.
- **Advanced Customization:** Deep customization, themes, and environment variables.
- **Enterprise Features:** SSO, user management, and permission controls.
- **Data Security:** Local file processing with automatic deletion post-task.
- **Scalability & Automation:** Batch processing with Docker and Kubernetes support.
- **API Integration:** Use APIs for automation and external integrations.
- **Open-Source:** Community-driven with frequent updates and GitHub support.
- **Multi-Language Support:** Available in 38+ languages with active translations.

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).


## Introduction

This guide will help you choose the right installation method based on your needs.
We prioritise and focus on our Server deployment options however we also offer a [Ultra-Lite model](/Installation/Versions) for desktop users

## Choose Your Installation Type
Expand All @@ -14,7 +29,6 @@ If you want to run Stirling PDF on your personal computer:
1. **Windows Users**
- Download our installer ([Stirling-PDF-win-installer.exe](https://github.com/Stirling-Tools/Stirling-PDF/releases/latest/download/Stirling-PDF-win-installer.exe)) for a simple, standalone experience
- Refer to our [Windows Installation Guide](/Installation/Windows%20Installation) for detailed setup instructions
- Note: A UI installer version is coming in the next release!

2. **Linux/Unix Users**
- Dedicated Linux installer to be released soon, Currently you must run Stirling-PDF as a java jar
Expand All @@ -37,15 +51,15 @@ If you're looking to host Stirling PDF as a service:

2. **Manual Server Setup**
- For bare metal server installations
- Use Stirling-PDF-Server package
- Use Stirling-PDF.jar package
- Follow our [Unix Installation Guide](/Installation/Unix%20Installation) for setup steps

## Quick Reference Table

| Installation Type | Best For | Documentation Link |
|------------------|----------|-------------------|
| Stirling-PDF.exe | Windows desktop users | [Windows Guide](/Installation/Windows%20Installation) |
| Stirling-PDF-Server | Server deployments without Docker | [Unix Guide](/Installation/Unix%20Installation) |
| Stirling-PDF-installer.exe | Windows desktop users | [Windows Guide](/Installation/Windows%20Installation) |
| Stirling-PDF.jar | Server deployments without Docker | [Unix Guide](/Installation/Unix%20Installation) |
| Docker Images | Server deployments with Docker | [Docker Guide](/Installation/Docker%20Install) |

Choose the installation method that best suits your needs and environment. Each guide provides detailed instructions for getting Stirling PDF up and running on your system.
28 changes: 0 additions & 28 deletions docs/Overview/What is Stirling-PDF.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/Overview/_category_.json

This file was deleted.

0 comments on commit af97906

Please sign in to comment.