RelaxedJS/ReLaXed
ReLaXed
ReLaXed is a document workflow and compilation system that transforms Markdown, JSON data, and HTML/CSS into print-ready PDF files. It utilizes a headless browser engine to render web technologies into final documents, serving as a build system for technical documentation and dynamic reports.
The project features a pipeline that automates asset generation, allowing scripts to produce images, charts, and tables from raw data files during the build process. It supports the integration of LaTeX formulas for mathematical equations and converts CSV files into formatted HTML tables.
The system includes a file-system watcher for automatic recompilation and a plugin architecture for adding custom variables and processing logic. It also provides middleware capabilities to transform the final HTML string and custom text filters to modify content before the PDF is rendered.
Features
- HTML to PDF Converters - Transforms web-based HTML and CSS layouts into professional, print-ready PDF files.
- Headless Rendering Engines - Uses a headless browser rendering engine to convert HTML and CSS layouts into precise PDF documents.
- Markdown PDF Compilers - Transforms Markdown files and JSON data into formatted PDF outputs with automatic recompilation.
- Document Compilers - Transforms source markup and data into formatted PDF outputs via a compilation pipeline.
- Dynamic PDF Generators - Generates professional PDF documents with complex layouts from dynamic templates.
- Data-Driven Templates - Injects structured JSON data into templates to generate dynamic, data-driven document content.
- Markdown-to-PDF Renderers - Provides high-quality PDF rendering of Markdown source content.
- Markdown to HTML Converters - Transforms Markdown plaintext and LaTeX formulas into structured HTML for rendering.
- Dynamic Document Generators - Injects JSON data and CSV files into templates to create dynamic, data-driven reports.
- Documentation Automation - Automates the compilation of source files into PDFs whenever filesystem changes are detected.
- Template Data Injection - Injects structured JSON variables into templates to create dynamic content.
- Content Processing and Transformation - Implements custom JavaScript filters and middleware to programmatically manipulate content during the build process.
- HTML Pre-processors - Executes JavaScript middleware to transform the final HTML string before PDF rendering.
- Post-Processing Hooks - Includes middleware capabilities to transform the final HTML string before PDF rendering.
- Template Text Transformations - Provides custom functions to process and transform template text blocks before final output.
- Build Pipeline Plugins - Provides a plugin architecture to intercept and transform assets and variables during the build lifecycle.
- File Watchers - Monitors the file system for changes to trigger automatic recompilation of documents.
- Technical Writing Workflows - Facilitates a specialized workflow for rendering LaTeX, markdown, and diagrams into a single technical document.
- Chart Generators - Renders visual charts and flowcharts from text-based definitions as SVGs or images.
- Equation Renderers - Transforms LaTeX formulas into formatted mathematical equations within documents.
- External Content Inclusions - Embeds specialized content like LaTeX equations and plots using external JavaScript libraries.
- Plugin Extenders - Allows loading external modules at runtime to add custom variables and processing logic to the pipeline.
- File System Monitors - Watches directories for modifications to trigger automatic document rebuilds and previews.
- CSV-to-HTML Table Generators - Translates CSV data files into formatted HTML tables for document inclusion.
- Data-Driven Asset Generators - Triggers scripts on file changes to automatically produce images and tables from raw data.
- Dynamic Asset Generators - Automates the creation of diagrams and tables from raw data files during the document build process.
- Documentation and Knowledge - Creates complex PDF layouts using CSS and JavaScript.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
