View Source mix ash.generate_resource_diagrams (ash v3.4.49)

Generates a Mermaid Resource Diagram for each Ash domain.

Prerequisites

This mix task requires the Mermaid CLI to be installed on your system.

See https://github.com/mermaid-js/mermaid-cli

Command line options

  • --type - er or class (defaults to class)
  • --only - only generates for the given domain
  • --format - Can be set to one of either:
    • plain - Prints just the mermaid output as text. This is the default.
    • md - Prints the mermaid diagram in a markdown code block.
    • svg - Generates an SVG
    • pdf - Generates a PDF
    • png - Generates a PNG

Summary

Functions

Generates Mermaid Resource Diagrams for each Ash domain

Functions

run(argv)

Generates Mermaid Resource Diagrams for each Ash domain