search

mermaid-js / mermaid

Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
https://mermaid.js.org
MIT License
70.82k stars 6.35k forks source link

Documentation: Old Documentation issue, mermaid.flowchartConfig #5288

Open ProbablePrime opened 7 months ago

ProbablePrime commented 7 months ago

Description

https://mermaid.js.org/syntax/flowchart.html#configuration Lists mermaid.flowchartConfig.width as a method to change the flowchart's width.

A quick search on the repo(https://github.com/search?q=repo%3Amermaid-js%2Fmermaid%20flowchartConfig&type=code) says that this property doesn't exist.

Additionally, https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/config.type.ts#L1433 doesn't contain a width property.

Therefore I believe this is an error. Git Blaming shows the last time that area was touched was 5 years ago.

Steps to reproduce

N/A

Screenshots

No response

Code Sample

No response

Setup

Suggested Solutions

Update the documentation

Additional Context

No response

nirname commented 3 months ago

Configuration options are now automatically generated https://mermaid.js.org/config/schema-docs/config.html and yes, documentation can be obsolete. Update it if needed

nirname commented 3 months ago

By the way, the link https://mermaid.js.org/syntax/flowchart.html#configuration seems to be broken, if you paste it

https://mermaid.js.org/syntax/flowchart.html#configuration

or click it https://mermaid.js.org/syntax/flowchart.html#configuration you'll get 2 different results. Some redirects are wrong.

Configuration options are here https://mermaid.js.org/config/schema-docs/config.html