Welcome to the ZPL2PDF documentation! This index helps you find the right documentation for your needs.
- 🇺🇸 English - Main README (root folder)
- 🇧🇷 Português (Brasil)
- 🇪🇸 Español
- 🇫🇷 Français
- 🇩🇪 Deutsch
- 🇮🇹 Italiano
- 🇯🇵 日本語
- 🇨🇳 中文 (简体)
Want to contribute improvements? See CONTRIBUTING.md
Documentation for end-users:
- 🚀 Quick Start Guide - Get up and running in 5 minutes
- 📦 Installation Guide - All installation methods
- 🐳 Docker Guide - Complete Docker usage and deployment
- 🧪 Docker Testing Guide - Test ZPL2PDF on all platforms with Docker
- 🌍 Multi-Language Configuration - Set up your preferred language
- 📦 Windows Installer Guide - Professional Windows installation
- 📦 Linux Packages Guide - Install on Linux (DEB, RPM)
- 🔌 REST API Guide - REST API usage and examples
- ⚙️ Configuration Reference - All configuration options
- 🔧 Troubleshooting - Common issues and solutions
- 📊 Performance Optimization - Benchmarks and tips
Documentation for contributors and developers:
- 🤝 Contributing Guide - How to contribute
- 📋 Changelog - Version history
- 🔄 CI/CD Workflow - Automated build and deployment
- 🔨 Build Scripts Documentation - Build for all platforms
- 🐳 Docker Publishing Guide - Publish Docker images
- 📦 Installer Documentation - Windows installer creation
- 📦 WinGet Guide - WinGet package submission
- 🔄 Git Workflow - Git workflow and branching strategy
- 🏗️ Architecture Overview
- 📚 API Documentation (Coming soon)
| Task | Documentation |
|---|---|
| Install ZPL2PDF | Installation Guide |
| Convert a ZPL file | Quick Start |
| Set up auto-conversion | Daemon Mode Guide |
| Use Docker | Docker Guide |
| Use REST API | REST API Guide |
| Change language | Language Configuration |
| Build from source | Development Setup |
| Contribute code | Contributing Guide |
| Report a bug | Bug Reports |
| Request a feature | Feature Requests |
| Publish a release | CI/CD Workflow |
| Test on Linux | Docker Testing |
docs/
├── README.md (This file - Documentation index)
├── i18n/ (Internationalization)
│ ├── README.pt-BR.md (Portuguese)
│ ├── README.es-ES.md (Spanish)
│ └── README.fr-FR.md (French)
├── guides/ (User guides - for end users)
│ ├── DOCKER_GUIDE.md (Docker usage and deployment)
│ ├── DOCKER_TESTING.md (Cross-platform testing with Docker)
│ ├── INNO_SETUP_GUIDE.md (Windows installer guide)
│ ├── LANGUAGE_CONFIGURATION.md (Multi-language setup)
│ ├── LINUX_PACKAGES.md (Linux package installation)
│ └── API_GUIDE.md (REST API usage and examples)
├── development/ (Developer docs - for contributors)
│ ├── CI_CD_WORKFLOW.md (CI/CD automation workflow)
│ ├── GIT_WORKFLOW_GUIDE.md (Git workflow and branching)
│ ├── DOCKER_PUBLISH_GUIDE.md (Docker image publishing)
│ └── WINGET_GUIDE.md (WinGet package submission)
├── Image/ (Screenshots & icons)
│ ├── ZPL2PDF.ico
│ ├── ZPL2PDF.png
│ └── example_*.png
└── Sample/ (Sample ZPL files)
├── example.txt
├── test-*.txt
└── *.prn
Can't find what you're looking for? Try:
- Search the Wiki: GitHub Wiki
- Browse Issues: GitHub Issues
- Ask in Discussions: GitHub Discussions
- 📅 2025-01-30: Release 3.0.2 — Issue #45 (labels with ~DGR), Issue #48 (TCP Server), PR #47 (REST API)
- 📅 2025-01-07: Docker Publishing Guide
- 📅 2025-01-07: Multi-language Configuration Guide
- 📅 2025-01-07: CI/CD Workflow Documentation
- 📅 2025-01-07: Inno Setup Guide
Found a typo or want to improve the docs?
- Fork the repository
- Edit the documentation
- Submit a Pull Request
See Contributing Guide for details.
Need help? Open an Issue or start a Discussion!