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

docs: Fix "Unsupported markdown: list" mermaid diagram errors #3361

Merged
merged 1 commit into from
Mar 1, 2025

Conversation

claremacrae
Copy link
Collaborator

Types of changes

Changes visible to users:

Description

Fix "Unsupported markdown: list" errors on mermaid diagrams in the "Tasks Dependencies" page.

Diagrams on the 'Task Dependencies' page were broken by Obsidian's update to Mermaid 11.

Fixes #3360

Motivation and Context

Fix #3360 by escaping the markdown list character in Mermaid diagrams.

This works around the following Mermaid issue:

How has this been tested?

  • Viewing the edited docs in Obsidian 1.8.9.

Screenshots (if appropriate)

Before After
image image

Checklist

  • My code follows the code style of this project and passes yarn run lint.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Terms

Diagrams on the 'Task Dependencies' page were broken by Obsidian's
update to Mermaid 11.

Fixes #3360
@claremacrae claremacrae added the scope: documentation Improvements or additions to documentation label Mar 1, 2025
Copy link

sonarqubecloud bot commented Mar 1, 2025

@claremacrae claremacrae merged commit 50e94b7 into main Mar 1, 2025
4 checks passed
@claremacrae claremacrae deleted the fix-mermaid-docs branch March 1, 2025 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation: mermaid blocks say "Unsupported markdown"
1 participant