Skip to content

Commit 6aae129

Browse files
authored
Docs: Fix broken diagram
Github updated to the latest version of Mermaid (v11.1.0), this caused an issue with our graph in `README.md`. Specifically, it does not support `\n` for breaking lines anymore (probably caused by the [introduction of new string syntax](mermaid-js/mermaid#4271)). This problem was fixed by replacing `\n` with `<br/>` In the case of Firefox, there is a problem that for long labels the whole label has disappeared ([issue](mermaid-js/mermaid#5785)). In case of Chrome, long labels were autowrapped which caused not good rendering. To fix this problem the font size of clusters were decreased.
1 parent eae2d9b commit 6aae129

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ config:
4343
/* redefinition of subgraphs labels */
4444
.cluster-label {
4545
font-family: monospace;
46-
font-size: 16px;
46+
font-size: 13px;
4747
}
4848
"
4949
themeVariables:
@@ -61,16 +61,16 @@ subgraph G[" "]
6161
%% nodes
6262
pv(project versions)
6363
sl(symbol list)
64-
subgraph sgSubgraph[diffkemp build\ndiffkemp build-kernel\ndiffkemp llvm-to-snapshot]
65-
sg(Snapshot\ngeneration)
64+
subgraph sgSubgraph[diffkemp build<br/>diffkemp build-kernel<br/>diffkemp llvm-to-snapshot]
65+
sg(Snapshot<br/>generation)
6666
end
6767
subgraph scSubgraph[diffkemp compare]
68-
sc(Semantic\ncomparison)
68+
sc(Semantic<br/>comparison)
6969
end
7070
subgraph rvSubgraph[diffkemp view]
7171
rv(Result viewer)
7272
end
73-
report[report for\nnot equal symbols]
73+
report[report for<br/>not equal symbols]
7474
neq(✗ not equal)
7575
eq(✓ equal)
7676
%% invisible node for making pv node more aligned with other nodes

0 commit comments

Comments
 (0)