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

produce cleaner markdown from readme #46

Merged
merged 3 commits into from
Aug 16, 2024
Merged

produce cleaner markdown from readme #46

merged 3 commits into from
Aug 16, 2024

Conversation

stavros-k
Copy link
Contributor

@stavros-k stavros-k commented Aug 16, 2024

Problem:

Markdown (and html) ignores single new lines.
To make it easier to layout long paragraphs in multiple lines
But when we convert md to html and them to json, 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 to html, 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 lines

Solution:

Replace the \n to . This makes the UI render correctly the README, without developer having to constantly think how to write the readme files.

More context:
https://ixsystems.atlassian.net/jira/software/c/projects/TNCHARTS/issues/TNCHARTS-1305

@stavros-k stavros-k merged commit 311ebe3 into master Aug 16, 2024
2 checks passed
@stavros-k stavros-k deleted the markdown branch August 16, 2024 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants