Skip to content

Deactivate mermaid  #8

@irm-codebase

Description

@irm-codebase

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions