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

fix($shared-utils): improve title inference and header extraction for markdown links syntax #2688

Merged
merged 6 commits into from
Dec 19, 2020

Conversation

nuochong
Copy link
Contributor

@nuochong nuochong commented Oct 31, 2020

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

before
image

after
image

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

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:

@billyyyyy3320
Copy link
Collaborator

Please at least provide summary or the issue you were facing

@nuochong
Copy link
Contributor Author

nuochong commented Nov 2, 2020

The following title cannot be resolved properly

### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup)
### [\<ins>](https://github.com/markdown-it/markdown-it-ins)
### [\<mark>](https://github.com/markdown-it/markdown-it-mark)

It was wrongly parsed as

<span>Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript</span>
<span>\</span>
<span>\</span>

The correct analysis should be

<span>Subscript / Superscript</span>
<span><ins></span>
<span><mark></span>

Sample snippet from: https://markdown-it.github.io/

@billyyyyy3320

Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 left a comment

Choose a reason for hiding this comment

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

Thanks @nuochong!

There're unit tests for both files, could you update test cases?

@nuochong
Copy link
Contributor Author

sure

@billyyyyy3320 billyyyyy3320 changed the title fix: title inference / header extraction logic (#238) fix: improve title inference and header extraction for markdown links syntax Dec 19, 2020
@billyyyyy3320 billyyyyy3320 changed the title fix: improve title inference and header extraction for markdown links syntax fix($shared-utils): improve title inference and header extraction for markdown links syntax Dec 19, 2020
@billyyyyy3320 billyyyyy3320 merged commit d264e50 into vuejs:master Dec 19, 2020
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.

2 participants