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

Replace headers in test .md files with bold text #954

Merged
merged 4 commits into from
Dec 16, 2019

Conversation

yash-chowdhary
Copy link
Contributor

What is the purpose of this pull request? (put "X" next to an item, remove the rest)

• [x] Other, please explain: Modification of markdown files of test sites

Fixes #740

What is the rationale for this request?
This PR replaces headers with bold text in an attempt to reduce noise (HTML content) generated.

What changes did you make? (Give an overview)
Replaced headers with **bold** text across various .md files in the test/ directory.

Provide some example code that this change will affect:
Screenshot of the affected site shown below:

Screenshot 2019-12-13 at 12 51 25 PM

Is there anything you'd like reviewers to focus on?
On running npm run updatetest, there were several (6-7) images that were flagged as "modified", but the image content itself remained unchanged. Should these "modified" images also be included in the PR?

Proposed commit message: (wrap lines at 72 characters)
Replace headers in test .md files with bold text

Copy link
Member

@yamgent yamgent left a comment

Choose a reason for hiding this comment

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

Thanks for cleaning this up.

I think these files can also be cleaned up:

  • test/functional/test_site/testAntiFOUCStyles.md
  • test/functional/test_site/testPlantUML.md
  • test/functional/test_site/testThumbnails.md
  • test/functional/test_site_algolia_plugin/index.md

Copy link
Member

@yamgent yamgent left a comment

Choose a reason for hiding this comment

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

Thanks, it is generally much cleaner now.

For the record, normally we would ask you to clean up the commits by squashing them into reasonable chunks (for this PR, a reasonable organization would just be a single commit "Replace headers in test .md files with bold text"). In interest of time I will just squash it for you now, but do take note of this in future PRs.

@yamgent yamgent added this to the v2.7.1 milestone Dec 16, 2019
@yamgent yamgent merged commit 28aac06 into MarkBind:master Dec 16, 2019
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.

Replace headings in test .md files with bolded text
2 participants