Consent document markdown doesn't appear to be working

[viraj-galen]

What Stanford Spezi module is your challenge related to?

Spezi

Description

I am attempting to write a custom consent document using the "ConsentDocument.md" file; however, the markdown doesn't show up as markdown in the app simulator, but rather plaintext. I didn't modify any other code other than the markdown file. Any help with this would be really appreciated!

Reproduction

I simply edited the markdown file; I didn't change any of the way the file is handled in the Consent.swift file.

Expected behavior

I expect to see markdown, not plaintext.

Additional context

No response

Code of Conduct

• I agree to follow this projects's Code of Conduct and Contributing Guidelines

[philippzagar]

Hi @viraj-galen,

Thank you for raising this discussion and for using SpeziOnboarding in your app! 🚀

Currently, SwiftUI sadly does not support the full Markdown syntax for the Text view. While it handles most standard Markdown elements (as outlined here: https://www.avanderlee.com/swiftui/markdown-text/), it does not support rendering headings, numbered lists, or images, see here: https://www.appcoda.com/swiftui-markdown/

These limitations are inherent to SwiftUI and cannot be circumvented at this time (except for using a custom UIKit-based Markdown renderer like https://github.com/gonzalezreal/swift-markdown-ui which comes with its own issues). We recognize this is not ideal and hope that future updates to SwiftUI will offer broader Markdown support.

Please feel free to reach out if you have any further questions.