Skip to content

Documentation preview errors in Flowchart syntax #6599

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

Open
kimulaco opened this issue May 17, 2025 · 0 comments · May be fixed by #6600
Open

Documentation preview errors in Flowchart syntax #6599

kimulaco opened this issue May 17, 2025 · 0 comments · May be fixed by #6600
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect

Comments

@kimulaco
Copy link

kimulaco commented May 17, 2025

Description

I found errors in the Flowchart documentation in the production and latest develop branch.

I previously reported a similar issue (#6455) about failing previews in the Flowchart documentation, which was fixed. However, I found two new documentation preview errors that are different from the previous issue:

  1. The Image Shape example code fails to render because the sample image URL (https://example.com/image.png) is not accessible
    • This error is occurring in production as well
  2. The Markdown Strings example has a syntax error

These issues are in different sections of the documentation and have various causes from the previous issue.

Steps to reproduce

  1. Checkout the develop branch and start a local server for docs
  2. Open the Flowchart documentation page (http://localhost:3333/syntax/flowchart.html)
  3. Check the Image Shape section - the preview is not rendered
  4. Check the Markdown Strings section - the preview is not rendered
  5. Scroll to the bottom of the page - you will see "Syntax error in text mermaid version 11.6.0" displayed

Screenshots

The following screenshot shows the docs for the latest develop branch.

Image

Code Sample


Setup

  • Mermaid version: 11.6.0
  • Browser and Version: [Chrome 136, Safari 18.4, Firefox 137]

Suggested Solutions

  1. For the Image Shape example:
  2. For the Markdown Strings example:

Additional Context

I'm prepared to create a Pull Request to fix these issues.

@kimulaco kimulaco added Type: Bug / Error Something isn't working or is incorrect Status: Triage Needs to be verified, categorized, etc labels May 17, 2025
@kimulaco kimulaco linked a pull request May 18, 2025 that will close this issue
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant