feat: support writing HTML(Vue) anywhere in the header. #711
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
Since VuePress needs to extract the header from the markdown source file and display it in the sidebar or title (#238), this file(
lib/util/parseHeaders.js
) simply removes some unnecessary elements to make header displays well at sidebar or title.But header's parsing in the markdown content is done by the markdown loader based on markdown-it. markdown-it parser will will always keep HTML in headers, so in VuePress, after being parsed by the markdiwn loader, the raw HTML in headers will finally be parsed by Vue-loader. so that we can write HTML/Vue in the header. One exception is the HTML wrapped by
<code>
(markdown token: '`') tag.This PR is to support writing HTML(Vue) anywhere in the header, not just at the end of the header.
Some key points about this PR:
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:
Close: #693
Close: #688
Close: #689
A correct solution to replace #694