View Source mix ash.generate_resource_diagrams (ash v2.4.12)

Generates a Mermaid Resource Diagram for each Ash API.

prerequisites

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

Command line options

  • --type - er or class (defaults to class)
  • --only - only generates the given API file
  • --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

Link to this section Summary

Functions

Callback implementation for Mix.Task.run/1.

Link to this section Functions

Callback implementation for Mix.Task.run/1.