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

Add padding to all <details> tags in markdown instructions #24574

Merged
merged 2 commits into from Sep 6, 2018
Merged

Conversation

Hamms
Copy link
Contributor

@Hamms Hamms commented Aug 30, 2018

In commonmark, in order to include markdown within html components, you must make sure to pad the markdown with newlines:

https://spec.commonmark.org/0.18/#example-108

Marked, unfortunately, will parse HTML content into markdown indiscriminately. We rely quite heavily on this functionality, mostly in the <details> tags that are used throughout CSD and CSP. This PR simply goes through and adds the necessary padding to all those instances, so they will render the same in both commonmark and marked.

I recommend reviewing with git diff --word-diff-regex=.

@Hamms Hamms changed the title [WIP] Add padding to all <details> tags in markdown instructions Add padding to all <details> tags in markdown instructions Sep 6, 2018
Copy link
Contributor

@balderdash balderdash left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skimmed the diff locally as you suggested, seems fine to me.

@Hamms Hamms merged commit 7f60c7c into staging Sep 6, 2018
@Hamms Hamms deleted the pad-details branch September 6, 2018 19:47
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.

None yet

2 participants