Documentation

Welcome to the Document Template Processing Service documentation.

Quick Start

Installation - Get the service running
Usage Guide - Quick start and overview
API Endpoints - Complete API reference
Document Templates - Create Jinja2 templates
🔍 DocX Linter - NEW: Template validation and error detection
Examples - Working code samples

Comprehensive Guides

🚀 Installation Guide

Complete setup instructions from local development to production deployment.

📋 Usage Guide

Quick start guide with essential concepts and links to detailed sections.

🔌 API Endpoints

Complete API reference with parameters, responses, and examples for all endpoints.

📄 Document Templates

Learn how to create Word templates with Jinja2 syntax:

Variable substitution and conditional logic
Loops and advanced template patterns
Best practices and troubleshooting

🖼️ Image Support

Advanced image processing capabilities:

Base64 encoding for React applications
Size specifications and optimization
Template integration and troubleshooting

🔍 DocX Linter ⭐ NEW

Comprehensive template validation system:

Automatic syntax checking and error detection
Integrated validation before document processing
Configurable linting options and quality analysis
Detailed error reporting with suggestions

🚫 Error Handling

Understanding and debugging errors:

HTTP status codes and error types
Structured error responses
Common issues and debugging strategies

💡 Examples

Complete practical examples:

Invoice generation with complex data
React, Node.js, and Python integration
Postman testing and real-world use cases

🐳 Integration Guide

Docker Compose setup and integration patterns for existing applications.

Architecture Overview

The service combines three powerful technologies:

docxtpl - Python library for Word template processing
Jinja2 - Template engine for dynamic content
Gotenberg - Microservice for PDF conversion

Features

✅ Unified API - Single endpoint with smart mode detection
✅ Image Support - Inline images with Base64 encoding
✅ Template Linting - NEW: Automatic validation before processing
✅ Error Handling - Comprehensive error reporting
✅ Docker Ready - Complete containerization
✅ React Friendly - Optimized for modern web applications
✅ Backward Compatible - No breaking changes for existing integrations

Quick Links

GitHub Repository
Docker Images
Live Service (when running locally)

Support

For questions and support:

Check the Error Handling guide
Try the Examples for working code
Review the API Endpoints reference
Create an issue in the GitHub repository