-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
$site.pages summary contains invalid markdown #2657
Comments
Hello @maxigimenez ! This seems to look like an API you guys have augmented your theme with here: https://github.com/checkly/theheadless.dev/blob/master/blog/.vuepress/theme/index.js#L6 I suspect the issue here might be with |
Thank you @d-pollard! Wasn't aware of that file in our configuration. |
No problem! Am interested in how you guys fix it, feel free to update and tag me here @maxigimenez |
@d-pollard We fix our logic to trim the summary checkly/theheadless.dev#84 to be done after the |
Bug report
Steps to reproduce
The summary provided on
this.$site.pages
can contain a broken markdown.We are facing this issue on https://theheadless.dev when the summary is trimmed based on the configured characters there could be scenarios where the markdow is not valid anymore (please check the image attached).
In our case, we are setting a max length of 120 characters (
summaryLength
config), and the text of the image above is:BTW this is a public repo, so feel free to check the configuration here https://github.com/checkly/theheadless.dev
What is expected?
Option A) before trimming, remove the markdown from the summary
Option B) trim the text without counting markdown characters, so it ensures that is always valid.
What is actually happening?
As attached below, the markdown is invalid so it looks weird.
Other relevant information
The text was updated successfully, but these errors were encountered: