feat: smooth scroll (#49)

Author: billyyyyy3320

docs/config/README.md

@@ -411,3 +411,18 @@ You can set this option to `SimplePagination` to enable another out-of-box
 You can also wirte a custom pagination component and register it as a global component. then pass its
 name to this option.
 
+## smoothScroll
+
+- Type: `boolean`
+- Default: `false`
+
+The `themeConfig.smoothScroll` option allows you to enable smooth scrolling.
+
+```JavaScript
+// .vuepress/config.js
+module.exports = {
+  themeConfig: {
+    smoothScroll: true
+  }
+}
+```

example/.vuepress/config.js

@@ -151,7 +151,7 @@ module.exports = {
      */
     newsletter: {
       endpoint: 'https://billyyyyy3320.us4.list-manage.com/subscribe/post?u=4905113ee00d8210c2004e038&id=bd18d40138'
-    }
+    },
     /**
      * Ref: https://vuepress-theme-blog.ulivz.com/#modifyblogpluginoptions
      */
@@ -196,5 +196,10 @@ module.exports = {
      */
 
     // paginationComponent: 'SimplePagination'
+
+    /**
+     * Ref: https://vuepress-theme-blog.ulivz.com/#smoothscroll
+     */
+    smoothScroll:true
   },
 }

index.js

@@ -73,6 +73,9 @@ module.exports = themeConfig => {
   /**
    * Integrate plugins
    */
+
+  const enableSmoothScroll = themeConfig.smoothScroll === true
+
   const plugins = [
     '@vuepress/plugin-nprogress',
     ['@vuepress/medium-zoom', true],
@@ -83,6 +86,7 @@ module.exports = themeConfig => {
       },
     ],
     ['@vuepress/blog', blogPluginOptions],
+    ['smooth-scroll', enableSmoothScroll],
   ]
 
   /**

package.json

@@ -49,7 +49,8 @@
     "@vuepress/plugin-search": "1.0.0",
     "dayjs": "^1.8.19",
     "remove-markdown": "^0.3.0",
-    "vue-feather-icons": "^4.21.0"
+    "vue-feather-icons": "^4.21.0",
+    "vuepress-plugin-smooth-scroll": "^0.0.9"
   },
   "devDependencies": {
     "babel-eslint": "^10.0.3",

test/__snapshots__/config.spec.js.snap

@@ -64,6 +64,10 @@ Object {
         },
       },
     ],
+    Array [
+      "smooth-scroll",
+      false,
+    ],
   ],
 }
 `;

yarn.lock

@@ -9383,7 +9383,7 @@ slice-ansi@^2.1.0:
     astral-regex "^1.0.0"
     is-fullwidth-code-point "^2.0.0"
 
-smoothscroll-polyfill@^0.4.3:
+smoothscroll-polyfill@^0.4.3, smoothscroll-polyfill@^0.4.4:
   version "0.4.4"
   resolved "https://registry.yarnpkg.com/smoothscroll-polyfill/-/smoothscroll-polyfill-0.4.4.tgz#3a259131dc6930e6ca80003e1cb03b603b69abf8"
   integrity sha512-TK5ZA9U5RqCwMpfoMq/l1mrH0JAR7y7KRvOBx0n2869aLxch+gT9GhN3yUfjiw+d/DiF1mKo14+hd62JyMmoBg==
@@ -10753,6 +10753,13 @@ vuepress-plugin-smooth-scroll@^0.0.3:
   dependencies:
     smoothscroll-polyfill "^0.4.3"
 
+vuepress-plugin-smooth-scroll@^0.0.9:
+  version "0.0.9"
+  resolved "https://registry.yarnpkg.com/vuepress-plugin-smooth-scroll/-/vuepress-plugin-smooth-scroll-0.0.9.tgz#6c5d01db60def3d7b976b53404e56b97da9e8f39"
+  integrity sha512-UXX+HLZO1NKVwyiOJlj0smh8F9dKnwybjEi7w/Mj9EYLhKrNYr5uXs+N+OTt8VwKCn3f0vZ1XAwFIjsPlD7GJA==
+  dependencies:
+    smoothscroll-polyfill "^0.4.4"
+
 vuepress@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/vuepress/-/vuepress-1.2.0.tgz#2f2cdf337ad40a3e4866dfd33e97b840db386af7"