Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deactivate mermaid #8

Open
irm-codebase opened this issue Mar 11, 2025 · 0 comments
Open

Deactivate mermaid #8

irm-codebase opened this issue Mar 11, 2025 · 0 comments
Labels
bug Something isn't working

Comments

@irm-codebase
Copy link
Member

irm-codebase commented Mar 11, 2025

Describe the bug
The auto-generated diagram for the docs has a couple of bugs:

  • auto-wrapping distorts paths, making them hard to read
  • underscores are confused with markdown italics

To Reproduce
An INTERFACE.yaml file like this:

---
title: geo_boundaries_module
---
flowchart LR
M((geo_boundaries_module))
C2[/"`**automatic**
    countries/{dataset}_{country}_{subtype}.parquet
    marineregions/eez.parquet
    `"/] --> M
M --> O1("`**results**
    shapes.parquet
    `")

leads to:

Image

Expected behavior
the wrapping can be avoided via configuration

%%{ init: {"themeVariables": { "wrap": "false" },
           "flowchart": { "markdownAutoWrap":"false",
                          "wrappingWidth": "" }
           }
}%%
flowchart LR
M((geo_boundaries_module))
C2[/"`**automatic**
    countries/{dataset}\_{country}\_{subtype}dsdsdsdsdsdsdsdsdssdsddsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsdsssssssss.parquet
    marineregions/eez.parquet
    `"/] --> M
M --> O1("`**results**
    shapes.parqusdsdsdsdsdsdsdet
    `")

Image

The underscores, however, cannot.
I'd say that it's best to avoid generating these diagrams. Using INTERFACE.yaml for reference is good enough.

@irm-codebase irm-codebase added the bug Something isn't working label Mar 11, 2025
@irm-codebase irm-codebase changed the title Deactivate mermaid diagram wrapping and Deactivate mermaid diagram wrapping Mar 11, 2025
@irm-codebase irm-codebase changed the title Deactivate mermaid diagram wrapping Deactivate mermaid Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant