Question 1

How do I add custom CSS to my Matic documentation?

Accepted Answer

Specify an 'assets' array in your .maticrc file with folder paths like ['css'], and Matic will recursively copy the files to the output directory, allowing you to style the generated HTML.

Question 2

Matic vs Swagger UI for JSON Schema documentation: which is better?

Accepted Answer

Matic is ideal for static, customizable HTML documentation from JSON schemas with full design control, while Swagger UI offers interactive API exploration. Choose Matic if you need templating flexibility over out-of-the-box interactivity.

Question 3

Does Matic support JSON Schema Draft 7?

Accepted Answer

No, Matic only supports JSON Schema Draft 3 and Draft 4, as stated in the README. For Draft 7 or later, you'll need to convert schemas or use alternative tools like JSON Schema documentation generators.

Question 4

How to generate an index page for all schemas in Matic?

Accepted Answer

Set the 'index' property to true or an object in .maticrc, and provide an index.jade template. Matic will automatically create a navigable index page linking to all documented schemas.

Question 5

Can Matic handle multiple schema files in one project?

Accepted Answer

Yes, Matic processes multiple schemas with folder-based mapping for individual templates or a single default template, configured via the 'folder' attribute in .maticrc to suit your documentation structure.

Question 6

Is Matic good for API documentation from OpenAPI specs?

Accepted Answer

Matic is designed for JSON schemas, not OpenAPI directly. You might need to extract JSON schemas from OpenAPI definitions first, making it less straightforward than tools like Redoc or Swagger UI for API docs.

Matic

What is Matic?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions