produce cleaner markdown from readme #46
Merged
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.
Problem:
Markdown (and html) ignores single new lines.
To make it easier to layout long paragraphs in multiple lines
But when we convert
md
tohtml
and them tojson
, those new lines are encoded in to the string and UI will actually render the new line.If we take the output
markdown.markdown
and directly write it tohtml
, it will display correctly (ignoring single new lines).But because we then place it in a
json
which encodes the new lines in, then the output displays the new linesSolution:
Replace the
. This makes the UI render correctly the README, without developer having to constantly think how to write the readme files.
\n
toMore context:
https://ixsystems.atlassian.net/jira/software/c/projects/TNCHARTS/issues/TNCHARTS-1305