Skip to content

Generated doc contains non-closing tags that breaks JSX syntax

Summary

This is not an actual bug, but rather a suggestion.

Generated docs from "vuedoc/md" module separates different contents (like methods, computed, listeners, etc) by joining their description with a <br> html tag. This is causing issues on my side because we are embedding the markdown in a React component which follows JSX syntax that do not allow non-closing elements.

My proposition would be to use <br /> instead of <br> as a more general accepted syntax and, still, continuing to be valid Markdown.

What is the current behavior?

Docs are generated with <br> tags separating multiple types of content.

What is the expected behavior?

Use <br /> instead.

Possible fixes

Multiple places here: https://gitlab.com/vuedoc/md/-/blob/master/lib/Markdown.js