-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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($theme-default): smooth scroll (close #567) #1881
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
13aa8e4
feat($plugin-active-header-links): replace throttle by debounce
meteorlxy ccbff92
feat($theme-default): use plugin-smooth-scroll (close #567)
meteorlxy 89713c6
feat($theme-default): smooth-scroll option
meteorlxy 6312d27
docs: smooth-scroll option of default theme
meteorlxy 321448b
docs: enable smooth-scroll
meteorlxy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
4 changes: 2 additions & 2 deletions
4
packages/@vuepress/plugin-active-header-links/clientRootMixin.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,46 +1,54 @@ | ||
| const path = require('path') | ||
|
|
||
| // Theme API. | ||
| module.exports = (options, ctx) => ({ | ||
| alias () { | ||
| const { themeConfig, siteConfig } = ctx | ||
| // resolve algolia | ||
| const isAlgoliaSearch = ( | ||
| themeConfig.algolia | ||
| || Object.keys(siteConfig.locales && themeConfig.locales || {}) | ||
| module.exports = (options, ctx) => { | ||
| const { themeConfig, siteConfig } = ctx | ||
|
|
||
| // resolve algolia | ||
| const isAlgoliaSearch = ( | ||
| themeConfig.algolia | ||
| || Object | ||
| .keys(siteConfig.locales && themeConfig.locales || {}) | ||
| .some(base => themeConfig.locales[base].algolia) | ||
| ) | ||
| return { | ||
| '@AlgoliaSearchBox': isAlgoliaSearch | ||
| ? path.resolve(__dirname, 'components/AlgoliaSearchBox.vue') | ||
| : path.resolve(__dirname, 'noopModule.js') | ||
| } | ||
| }, | ||
| ) | ||
|
|
||
| plugins: [ | ||
| ['@vuepress/active-header-links', options.activeHeaderLinks], | ||
| '@vuepress/search', | ||
| '@vuepress/plugin-nprogress', | ||
| ['container', { | ||
| type: 'tip', | ||
| defaultTitle: { | ||
| '/': 'TIP', | ||
| '/zh/': '提示' | ||
| } | ||
| }], | ||
| ['container', { | ||
| type: 'warning', | ||
| defaultTitle: { | ||
| '/': 'WARNING', | ||
| '/zh/': '注意' | ||
| } | ||
| }], | ||
| ['container', { | ||
| type: 'danger', | ||
| defaultTitle: { | ||
| '/': 'WARNING', | ||
| '/zh/': '警告' | ||
| const enableSmoothScroll = themeConfig.smoothScroll === true | ||
|
|
||
| return { | ||
| alias () { | ||
| return { | ||
| '@AlgoliaSearchBox': isAlgoliaSearch | ||
| ? path.resolve(__dirname, 'components/AlgoliaSearchBox.vue') | ||
| : path.resolve(__dirname, 'noopModule.js') | ||
| } | ||
| }] | ||
| ] | ||
| }) | ||
| }, | ||
|
|
||
| plugins: [ | ||
| ['@vuepress/active-header-links', options.activeHeaderLinks], | ||
| '@vuepress/search', | ||
| '@vuepress/plugin-nprogress', | ||
| ['container', { | ||
| type: 'tip', | ||
| defaultTitle: { | ||
| '/': 'TIP', | ||
| '/zh/': '提示' | ||
| } | ||
| }], | ||
| ['container', { | ||
| type: 'warning', | ||
| defaultTitle: { | ||
| '/': 'WARNING', | ||
| '/zh/': '注意' | ||
| } | ||
| }], | ||
| ['container', { | ||
| type: 'danger', | ||
| defaultTitle: { | ||
| '/': 'WARNING', | ||
| '/zh/': '警告' | ||
| } | ||
| }], | ||
| ['smooth-scroll', enableSmoothScroll] | ||
| ] | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's TBD that if we should enable
smoothScrollfor official docs site. cc @ulivz @kefranabgThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I support trying out new features in our official docs.