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

Adds option for specifying the top offset #1005

Merged
merged 2 commits into from
Nov 16, 2018
Merged

Adds option for specifying the top offset #1005

merged 2 commits into from
Nov 16, 2018

Conversation

bretterer
Copy link
Contributor

@bretterer bretterer commented Nov 14, 2018

Summary
Allowing the addition of a theme that is not the default VuePress theme, the header is not always going to be 90. This PR allows you to define the option of the top offset from the configuration of the plugin.

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:

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

This also includes documentation update on how to specify options for this plugin

Copy link
Member

@ulivz ulivz left a comment

Choose a reason for hiding this comment

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

Thanks for the work, just some tweaks

}
```

## Options
```javascript
Copy link
Member

Choose a reason for hiding this comment

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

It would be better to move this usage to the above.

### headerTopOffset

- Type: `integer`
- Default: `90`
Copy link
Member

Choose a reason for hiding this comment

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

Missing description for this option.

@bretterer
Copy link
Contributor Author

@ulivz updated

@ulivz ulivz merged commit 100bbf2 into vuejs:master Nov 16, 2018
@bretterer
Copy link
Contributor Author

@ulivz it seems this change is no longer in the active-header-links plugin?

What happened?

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