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

feat($markdown): make page suffix configurable (close #2452) #2674

Merged
merged 2 commits into from Nov 10, 2020
Merged

feat($markdown): make page suffix configurable (close #2452) #2674

merged 2 commits into from Nov 10, 2020

Conversation

dennisreimann
Copy link
Contributor

Summary

Extends the markdown link plugin with an option for the page suffix, which is currently hardcoded to .html.

This fixes broken links in the markup (and hence non-js version) when using the clean urls plugin. See #2452 for details.

Fixes #2452.

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:z

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

Other information:

See the associated feature request issue for detailed description and previous discussion.

Extends the markdown link plugin with an option for the page suffix, which is currently hardcoded to `.html`.

This fixes broken links in the markup (and hence non-js version) when using the clean urls plugin. See #2452 for details.

Closes #2452.
@dennisreimann
Copy link
Contributor Author

As this potentially fixes the issues #2420 and #2424 – maybe the authors @davidgiga1993 and @chengyuhui can help verify, that this fixes the problems they mentioned. Also cc @cwaring :)

@dennisreimann
Copy link
Contributor Author

Let me know if something is unclear here – other than that it'd be good to get some feedback on whether or not this fixes the mentioned issues. Would love to see this merged :)

@billyyyyy3320
Copy link
Collaborator

Overall LGTM.

@billyyyyy3320 billyyyyy3320 changed the title feat($markdown): configurable page suffix, fix #2452 feat($markdown): make page suffix configurable (close #2452) Nov 10, 2020
@billyyyyy3320 billyyyyy3320 merged commit db16389 into vuejs:master Nov 10, 2020
@cwaring
Copy link

cwaring commented Nov 11, 2020

Thanks for making this happen @dennisreimann & @billyyyyy3320 🥳

@dennisreimann dennisreimann deleted the page-suffix branch November 11, 2020 17:24
dennisreimann added a commit to dennisreimann/btcpayserver-doc that referenced this pull request Jan 20, 2021
dennisreimann added a commit to dennisreimann/btcpayserver-doc that referenced this pull request Jan 20, 2021
Removes our moneypatch for Vuepress now that there is a release with vuejs/vuepress#2674 merged.
- Type: `string`
- Default: `.html`

Option to customize internal links to be compatible when using the [vuepress-plugin-clean-urls](https://vuepress.github.io/en/plugins/clean-urls/).
Copy link

Choose a reason for hiding this comment

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

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.

Make page suffix configurable (currently fixed to .html)
4 participants