Merge branch 'master' into register-command-plugin-api

Author: ulivz

Diff for: README.md

@@ -52,19 +52,19 @@ yarn add vuepress@next -D  # Install next.
 
 **Vue-powered custom theme system**
 
-* [Metadata](https://vuepress.vuejs.org/guide/custom-themes.html#site-and-page-metadata)
-* [Content Excerpt](https://vuepress.vuejs.org/guide/custom-themes.html#content-excerpt)
+* [Metadata](https://vuepress.vuejs.org/theme/writing-a-theme.html#site-and-page-metadata)
+* [Content Excerpt](https://vuepress.vuejs.org/theme/writing-a-theme.html#content-excerpt)
 
 **Default theme**
 
 * Responsive layout
-* [Optional Homepage](https://vuepress.vuejs.org/default-theme-config/#homepage)
-* [Simple out-of-the-box header-based search](https://vuepress.vuejs.org/default-theme-config/#built-in-search)
-* [Algolia Search](https://vuepress.vuejs.org/default-theme-config/#algolia-search)
-* Customizable [navbar](https://vuepress.vuejs.org/default-theme-config/#navbar) and [sidebar](https://vuepress.vuejs.org/default-theme-config/#sidebar)
-* [Auto-generated GitHub link and page edit links](https://vuepress.vuejs.org/default-theme-config/#git-repo-and-edit-links)
-* [PWA: Popup UI to refresh contents](https://vuepress.vuejs.org/default-theme-config/#popup-ui-to-refresh-contents)
-* [Last Updated](https://vuepress.vuejs.org/default-theme-config/#last-updated)
+* [Optional Homepage](https://vuepress.vuejs.org/theme/default-theme-config.html#homepage)
+* [Simple out-of-the-box header-based search](https://vuepress.vuejs.org/theme/default-theme-config.html#built-in-search)
+* [Algolia Search](https://vuepress.vuejs.org/theme/default-theme-config.html#algolia-search)
+* Customizable [navbar](https://vuepress.vuejs.org/theme/default-theme-config.html#navbar) and [sidebar](https://vuepress.vuejs.org/theme/default-theme-config.html#sidebar)
+* [Auto-generated GitHub link and page edit links](https://vuepress.vuejs.org/theme/default-theme-config.html#git-repo-and-edit-links)
+* [PWA: Popup UI to refresh contents](https://vuepress.vuejs.org/theme/default-theme-config.html#popup-ui-to-refresh-contents)
+* [Last Updated](https://vuepress.vuejs.org/theme/default-theme-config.html#last-updated)
 
 **Miscellaneous**
 

Diff for: packages/@vuepress/core/lib/app/app.js

@@ -62,7 +62,15 @@ export function createApp (isServer) {
     base: siteData.base,
     mode: 'history',
     fallback: false,
-    routes
+    routes,
+    scrollBehavior (to, from, savedPosition) {
+      if (savedPosition) {
+        return savedPosition
+      }
+      if (to.path !== from.path) {
+        return { x: 0, y: 0 }
+      }
+    }
   })
 
   // redirect /foo to /foo/

Diff for: packages/@vuepress/core/lib/app/root-mixins/updateLoadingState.js

@@ -1,43 +1,13 @@
-import SmoothScroll from 'smooth-scroll/dist/smooth-scroll.js'
-
 export default {
   created () {
     this.$vuepress.$on('AsyncMarkdownContentMounted', () => {
       this.$vuepress.$set('contentMounted', true)
-
-      this.$smoothScroll = new SmoothScroll('a[href*="#"]', {
-        speed: 1,
-        speedAsDuration: true,
-        easing: 'easeInOutCubic'
-      })
-
-      if (this.$route.hash) {
-        const hash = decodeURIComponent(this.$route.hash)
-        try {
-          const anchor = document.getElementById(hash.slice(1))
-          const anchorLink = anchor.querySelector('a.header-anchor')
-          setTimeout(() => {
-            window.scroll({
-              top: anchorLink.offsetTop - 70,
-              left: 0,
-              behavior: 'auto'
-            })
-          })
-        } catch (e) {
-          console.error(e)
-        }
-      }
     })
   },
 
   watch: {
     '$route.path' () {
       this.$vuepress.$set('contentMounted', false)
-      this.$smoothScroll.destroy()
     }
-  },
-
-  beforeDestroy () {
-    this.$smoothScroll.destroy()
   }
 }

Diff for: packages/@vuepress/core/lib/build.js

@@ -63,21 +63,23 @@ module.exports = async function build (sourceDir, cliOptions = {}) {
     .map(renderHeadTag)
     .join('\n  ')
 
+  // if the user does not have a custom 404.md, generate the theme's default
+  if (!ctx.pages.some(p => p.path === '/404.html')) {
+    ctx.addPage({ path: '/404.html' })
+  }
+
   // render pages
   logger.wait('Rendering static HTML...')
-  for (const page of ctx.pages) {
-    await renderPage(page)
-  }
 
-  // if the user does not have a custom 404.md, generate the theme's default
-  if (!ctx.pages.some(p => p.path === '/404.html')) {
-    await renderPage({ path: '/404.html' })
+  const pagePaths = []
+  for (const page of ctx.pages) {
+    pagePaths.push(await renderPage(page))
   }
 
   readline.clearLine(process.stdout, 0)
   readline.cursorTo(process.stdout, 0)
 
-  await ctx.pluginAPI.options.generated.apply()
+  await ctx.pluginAPI.options.generated.apply(pagePaths)
 
   // DONE.
   const relativeDir = path.relative(cwd, outDir)
@@ -155,6 +157,7 @@ module.exports = async function build (sourceDir, cliOptions = {}) {
     const filePath = path.resolve(outDir, filename)
     await fs.ensureDir(path.dirname(filePath))
     await fs.writeFile(filePath, html)
+    return filePath
   }
 
   function renderPageMeta (meta) {

Diff for: packages/@vuepress/core/lib/plugin-api/abstract/AsyncOption.js

@@ -30,7 +30,7 @@ class AsyncOption extends Option {
         this.add(
           name,
           isFunction(value)
-            ? await value(...args)
+            ? await Promise.resolve(value(...args))
             : value
         )
       } catch (error) {
@@ -60,7 +60,7 @@ class AsyncOption extends Option {
         this.add(
           name,
           isFunction(value)
-            ? await value(...args)
+            ? await Promise.resolve(value(...args))
             : value
         )
       } catch (error) {
@@ -84,7 +84,7 @@ class AsyncOption extends Option {
 
   async pipeline (input) {
     for (const fn of this.values) {
-      input = await fn(input)
+      input = await Promise.resolve(fn(input))
     }
     return input
   }

Diff for: packages/@vuepress/core/lib/plugin-api/constants.js

@@ -5,7 +5,7 @@ const PLUGIN_OPTION_META_MAP = {
   READY: { name: 'ready', types: [Function] },
   COMPILED: { name: 'compiled', types: [Function] },
   UPDATED: { name: 'updated', types: [Function] },
-  GENERATED: { name: 'generated', types: [Function] },
+  GENERATED: { name: 'generated', types: [Function], async: true },
   // options
   CHAIN_WEBPACK: { name: 'chainWebpack', types: [Function] },
   ENHANCE_DEV_SERVER: { name: 'enhanceDevServer', types: [Function] },

Diff for: packages/@vuepress/core/lib/plugin-api/index.js

@@ -147,7 +147,7 @@ module.exports = class PluginAPI {
   initializeOptions () {
     Object.keys(PLUGIN_OPTION_MAP).forEach(key => {
       const option = PLUGIN_OPTION_MAP[key]
-      this.options[option.name] = instantiateOption(option.name)
+      this.options[option.name] = instantiateOption(option)
     })
   }
 

Diff for: packages/@vuepress/core/lib/plugin-api/override/AdditionalPagesOption.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const AsyncOption = require('../abstract/AsyncOption')
+
+/**
+ * additionalPages option.
+ */
+
+module.exports = class AdditionalPagesOption extends AsyncOption {
+  async apply (ctx) {
+    await super.asyncApply()
+
+    await Promise.all(
+      this.appliedValues.map(async (options) => {
+        await ctx.addPage(options)
+      })
+    )
+  }
+}

Diff for: packages/@vuepress/core/lib/plugin-api/override/instantiateOption.js

@@ -3,10 +3,12 @@ const ClientDynamicModulesOption = require('./ClientDynamicModulesOption')
 const GlobalUIComponentsOption = require('./GlobalUIComponentsOption')
 const DefineOption = require('./DefineOption')
 const AliasOption = require('./AliasOption')
+const AsyncOption = require('../abstract/AsyncOption')
+const AdditionalPagesOption = require('./AdditionalPagesOption')
 const Option = require('../abstract/Option')
 const { PLUGIN_OPTION_MAP } = require('../constants')
 
-module.exports = function instantiateOption (name) {
+module.exports = function instantiateOption ({ name, async }) {
   switch (name) {
   case PLUGIN_OPTION_MAP.ENHANCE_APP_FILES.name:
     return new EnhanceAppFilesOption(name)
@@ -23,6 +25,9 @@ module.exports = function instantiateOption (name) {
   case PLUGIN_OPTION_MAP.ALIAS.name:
     return new AliasOption(name)
 
-  default: return new Option(name)
+  case PLUGIN_OPTION_MAP.ADDITIONAL_PAGES.name:
+    return new AdditionalPagesOption(name)
+
+  default: return async ? new AsyncOption(name) : new Option(name)
   }
 }

Diff for: packages/@vuepress/core/lib/prepare/AppContext.js

@@ -104,11 +104,7 @@ module.exports = class AppContext {
     this.markdown = createMarkdown(this)
 
     await this.resolvePages()
-    await Promise.all(
-      this.pluginAPI.options.additionalPages.values.map(async (options) => {
-        await this.addPage(options)
-      })
-    )
+    await this.pluginAPI.options.additionalPages.apply(this)
 
     await this.pluginAPI.options.ready.apply()
     await Promise.all([

Diff for: packages/@vuepress/core/package.json

@@ -55,7 +55,6 @@
     "optimize-css-assets-webpack-plugin": "^4.0.0",
     "portfinder": "^1.0.13",
     "postcss-loader": "^2.1.5",
-    "smooth-scroll": "^15.0.0",
     "toml": "^2.3.3",
     "url-loader": "^1.0.1",
     "vue": "^2.5.16",

Diff for: packages/docs/docs/plugin/option-api.md

@@ -354,7 +354,7 @@ export default {
 
 ## additionalPages
 
-- Type: `Array|Function`
+- Type: `Array|AsyncFunction`
 - Default: `undefined`
 
 Add a page pointing to a markdown file:

Diff for: yarn.lock

@@ -7606,10 +7606,6 @@ [email protected]:
   dependencies:
     is-fullwidth-code-point "^2.0.0"
 
-smooth-scroll@^15.0.0:
-  version "15.0.0"
-  resolved "https://registry.yarnpkg.com/smooth-scroll/-/smooth-scroll-15.0.0.tgz#be4f9cb2cc4952d80db6736e5656ed5849305272"
-
 snapdragon-node@^2.0.1:
   version "2.1.1"
   resolved "https://registry.yarnpkg.com/snapdragon-node/-/snapdragon-node-2.1.1.tgz#6c175f86ff14bdb0724563e8f3c1b021a286853b"