Matic

Overview

Matic is an innovative build tool designed to generate clear and well-organized HTML documentation from JSON schemas. By utilizing Jade templates, Matic makes it easy for users to present schema information in an accessible format. This tool supports both JSON schema draft 3 and draft 4, making it versatile for various documentation needs.

Setting up Matic is straightforward, as it requires minimal configuration for basic use. Users will need a directory with at least one schema document and one template file. Furthermore, while it operates with default settings, Matic allows for extensive customization through a .maticrc file, enabling developers to tailor the documentation process to meet their specific project requirements.

Features

• Easy Configuration: Matic provides a default setup that is ready to go, while also allowing users to modify configurations through a .maticrc file for more flexibility.
• Support for Multiple Schemas: The tool can handle multiple schema files efficiently, rendering them based on corresponding templates for clearer documentation.
• Output Customization: Users can specify the target output folder and file suffixes, allowing them to define exactly how and where the rendered files will be saved.
• Indentation Control: Matic allows users to set indentation levels for schema files, ensuring that the generated documentation meets their preferred formatting style.
• Template Mapping: Offers the ability to map multiple templates to corresponding schemas, enabling detailed explanations or examples specific to each schema.
• Broad Compatibility: Compatible with JSON schema draft 3 and draft 4, making it a reliable choice for a variety of documentation projects.
• Intuitive Output Structure: Automatically generates an organized output directory, making it easy to manage and locate rendered documentation files.