This repository has been archived by the owner on May 13, 2024. It is now read-only.
fix: remove markdown from content before slice #109
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
billyyyyy3320
suggested changes
Oct 31, 2020
Comment on lines
+140
to
+141
| removeMd(strippedContent.trim()) | ||
| .replace(/^#+\s+(.*)/, '') |
There was a problem hiding this comment.
In this case, title will not be removed from summary.
Suggested change
| removeMd(strippedContent.trim()) | |
| .replace(/^#+\s+(.*)/, '') | |
| removeMd(strippedContent.trim() .replace(/^#+\s+(.*)/, '')) |
There was a problem hiding this comment.
If the replace is made before removeMd, the content might end up with a broken markdown again. Can you explain why the replace regex is needed?
There was a problem hiding this comment.
IMO, It won't end up with a broken markdown. The replace regex is removing title (The first heading 1). We don't need title in summary.
For example, Given below Markdown source:
# Markdown Slot
VuePress implements a content distribution API for Markdown. With this feature, you can split your document into multiple fragments to facilitate flexible composition in the layout component.Without title
With title
There was a problem hiding this comment.
Sorry for the late reply, I didn't notice I haven't submit the pending comment
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
What kind of change does this PR introduce? (check at least one)
If changing the UI of default theme, please provide the before/after screenshot:
Does this PR introduce a breaking change? (check one)
If yes, please describe the impact and migration path for existing applications:
The PR fulfills these requirements:
fix #xxx[,#xxx], where "xxx" is the issue number)You have tested in the following browsers: (Providing a detailed version will be better.)
If adding a new feature, the PR's description includes:
To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.
Other information:
The summary provided can contain a broken markdown.
We faced this issue on https://theheadless.dev when the summary were trimmed based on the configured characters, there were scenarios where the markdow was not valid anymore (please check the image attached).
This PR changes the logic to remove the markdown of the summary first and then slice the content. We introduce the same fix in our config and works as expected.
More info
vuejs/vuepress#2657
checkly/theheadless.dev#84