Add support for markdown formatting in descriptions #759
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
atextor
requested changes
May 16, 2025
There was a problem hiding this comment.
The PR should also add one test Aspect Model that uses Markdown in a description, with
- a bullet list
- an ordered list
- at least one block
- at least one link.
This makes sure that no other SDK component breaks because of the markdown.
Then, in the documentation generation test, there should be test that asserts that the generated HTML does not contain the [...](url) structure.
...t-meta-model-java/src/main/java/org/eclipse/esmf/aspectmodel/utils/MarkdownHtmlRenderer.java
Outdated
Show resolved
Hide resolved
...-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtilsTest.java
Outdated
Show resolved
Hide resolved
...-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtilsTest.java
Outdated
Show resolved
Hide resolved
...-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtilsTest.java
Outdated
Show resolved
Hide resolved
...-meta-model-java/src/test/java/org/eclipse/esmf/aspectmodel/utils/DescriptionsUtilsTest.java
Outdated
Show resolved
Hide resolved
...model-document-generators/src/main/resources/docu/templates/html/common-documentation-lib.vm
Show resolved
Hide resolved
atextor
requested changes
May 16, 2025
.../java/org/eclipse/esmf/aspectmodel/generator/docu/AspectModelDocumentationGeneratorTest.java
Outdated
Show resolved
Hide resolved
...odels/src/main/resources/valid/org.eclipse.esmf.test/1.0.0/AspectWithMarkdownDescription.ttl
Outdated
Show resolved
Hide resolved
atextor
approved these changes
May 19, 2025
Yauhenikapl
deleted the
723-support-for-markdown-formatting-in-descriptions
branch
|
Release v2.10.4 addresses this. |
1 similar comment
|
Release v2.10.4 addresses this. |
|
Release v2.11.0 addresses this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add support for markdown formatting in descriptions.
Fixes #723
Type of change
Please delete options that are not relevant.
Checklist:
Additional notes