A build tool that generates HTML documentation from JSON schemas using customizable Jade templates.
Matic is a Node.js build tool that automatically generates HTML documentation from JSON schemas. It solves the problem of manually documenting complex JSON schemas by providing a template-driven approach to create clear, maintainable documentation. It supports JSON Schema Draft 3 and Draft 4, making it suitable for projects using these standards.
Developers and technical writers working with JSON schemas who need to generate and maintain up-to-date documentation for APIs, data structures, or configuration formats.
Matic offers a lightweight, customizable alternative to manual documentation, with flexible configuration and template support that allows teams to tailor documentation output to their specific branding and informational needs.
Automated HTML documentation for JSON schemas
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Uses Jade templates for rendering, allowing developers full control over HTML output and styling, enabling bespoke documentation sites as shown in the example project.
Highly configurable via a .maticrc file with options for output paths, file suffixes, and asset management, making it adaptable to diverse project layouts and needs.
Supports both folder-based and default template mapping, enabling per-schema customization or consistent documentation across multiple schemas with minimal effort.
Includes asset copying for CSS, JS, and images via the assets array in .maticrc, streamlining the inclusion of static resources without manual workflows.
Only supports JSON Schema Draft 3 and Draft 4, making it incompatible with newer versions like Draft 7 or 2020-12, which limits modern schema documentation.
Relies on Jade (now Pug) templates with limited testing for other libraries, requiring specific syntax knowledge and potentially hindering team adoption.
Produces static HTML files without built-in interactivity, such as live validation or search, necessitating additional custom JavaScript for dynamic features.