Don't use linebreaks filter in Markdown templates (#64) #133
Conversation
This file contains 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
The Markdown Django templates were using the linebreaks filter on some of the content. This filter wraps content using <p> and <br />. However this means that if the ontology was using Markdown in their comments this would not get rendered as most Markdown renderers don't apply rendering inside of HTML block elements like <p>. It was also unnecessary since Markdown renderers already use line breaks to suitably render paragraphs. This was most applicable for descriptions of things since those are the places were ontology authors were most likely to want to use Markdown to explain the intended usage of their ontology concepts. By removing the use of this filter the ontology descriptions are output as-is in the generated Markdown files allowing any Markdown in them to be rendered by whatever Markdown renderer the user ultimately chooses.
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.
The Markdown Django templates were using the linebreaks filter on some of the content. This filter wraps content using
<p>and<br />. However this means that if the ontology was using Markdown in their comments this would not get rendered as most Markdown renderers don't apply rendering inside of HTML block elements like<p>. It was also unnecessary since Markdown renderers already use line breaks to suitably render paragraphs.This was most applicable for descriptions of things since those are the places were ontology authors were most likely to want to use Markdown to explain the intended usage of their ontology concepts.
By removing the use of this filter the ontology descriptions are output as-is in the generated Markdown files allowing any Markdown in them to be rendered by whatever Markdown renderer the user ultimately chooses.
This resolves #64