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

KDoc rendering looks odd on 2024 Nightly IntelliJ #585

Closed
Jolanrensen opened this issue Feb 12, 2024 · 5 comments · Fixed by #613
Closed

KDoc rendering looks odd on 2024 Nightly IntelliJ #585

Jolanrensen opened this issue Feb 12, 2024 · 5 comments · Fixed by #613
Assignees
Labels
KDocs Improvements or additions to KDocs

Comments

@Jolanrensen
Copy link
Collaborator

image

Looks like KDocs need to be checked such that no spaces exist outside inline code blocks.

In comparison, this is what it currently looks like:
image

@Jolanrensen Jolanrensen added the KDocs Improvements or additions to KDocs label Feb 12, 2024
@Jolanrensen Jolanrensen added this to the KDocs for the public API milestone Feb 12, 2024
@Jolanrensen Jolanrensen self-assigned this Feb 12, 2024
@Jolanrensen
Copy link
Collaborator Author

I suspect IntelliJ now leans more into their Markdown Renderer.

This renderer trims code spans:

https://github.com/JetBrains/markdown/blob/aa54cceca5c28b694dcb7c940e910612c82fa76e/src/commonMain/kotlin/org/intellij/markdown/html/GeneratingProviders.kt#L73

Making things like this look weird:
image

@Jolanrensen
Copy link
Collaborator Author

Depends on JetBrains/markdown#150

@Jolanrensen
Copy link
Collaborator Author

https://youtrack.jetbrains.com/issue/IDEA-348571/Markdown-KDoc-rendering-errors
This will fix at least some space-trimming errors, hopefully enough to make the KDocs look okay

@Jolanrensen
Copy link
Collaborator Author

Another nice example of how broken it is.
image

@Jolanrensen
Copy link
Collaborator Author

https://youtrack.jetbrains.com/issue/KTIJ-29221/Markdown-KDoc-space-rendering-errors is done! The KDocs look a lot better now :) (in the latest 2024.1 nightly)
image

I did create a new YT issue to track the other rendering errors: https://youtrack.jetbrains.com/issue/KTIJ-29221/Markdown-KDoc-space-rendering-errors

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
KDocs Improvements or additions to KDocs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant