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: plugin clean urls #1339

Merged
merged 3 commits into from
Feb 26, 2019
Merged

feat: plugin clean urls #1339

merged 3 commits into from
Feb 26, 2019

Conversation

shigma
Copy link
Collaborator

@shigma shigma commented Feb 24, 2019

Summary

Add a new plugin @vuepress/vuepress-plugin-clean-urls.

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:

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:

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:

This plugin supports two options:

normalSuffix

  • Type: string
  • Default: ''

The suffix for normal pages. For example, foo/bar.md will become:

  • foo/bar.html by default (without this plugin)
  • foo/bar/ (with normalSuffix set to '/')
  • foo/bar (with normalSuffix set to '')

indexSuffix

  • Type: string
  • Default: '/'

The suffix for index pages. For example, foo/index.md will become:

  • foo/ by default (without this plugin)
  • foo (with indexSuffix set to '')
  • foo/index.html (with indexSuffix set to '/index.html')

@shigma shigma requested a review from ulivz February 24, 2019 12:59
@ulivz ulivz self-assigned this Feb 24, 2019
@ulivz ulivz added the topic: config Relates to VuePress config label Feb 24, 2019
@ulivz ulivz merged commit 40b3da8 into master Feb 26, 2019
@shigma shigma mentioned this pull request Feb 26, 2019
18 tasks
@shigma shigma deleted the plugin-clean-urls branch February 27, 2019 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: config Relates to VuePress config
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants