Merge branch 'master' of https://github.com/vuejs/vuepress into explode-md-includes

Author: ycmjason

README.md

@@ -1,9 +1,15 @@
 <p align="center">
   <a href="https://vuepress.vuejs.org/" target="_blank">
-    <img width="280" src="https://github.com/vuejs/vuepress/blob/master/docs/.vuepress/public/hero.png" alt="logo">
+    <img width="280" src="https://raw.githubusercontent.com/vuejs/vuepress/master/docs/.vuepress/public/hero.png" alt="logo">
   </a>
 </p>
 
+<p align="center">
+  <a href="https://npmcharts.com/compare/vuepress?minimal=true"><img src="https://img.shields.io/npm/dm/vuepress.svg" alt="Downloads"></a>
+  <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/v/vuepress.svg" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/vuepress"><img src="https://img.shields.io/npm/l/vuepress.svg" alt="License"></a>
+</p>
+
 # VuePress
 
 > Minimalistic docs generator with Vue component based layout system
@@ -15,13 +21,14 @@ https://vuepress.vuejs.org/
 - [Built-in markdown extensions](https://vuepress.vuejs.org/guide/markdown.html) optimized for technical documentation
 - [Ability to leverage Vue inside markdown files](https://vuepress.vuejs.org/guide/using-vue.html)
 - [Vue-powered custom theme system](https://vuepress.vuejs.org/guide/custom-themes.html)
-- Service Worker Integration
-- Google Analytics Integration
-- Multi-Language Support
+- [Service Worker Integration](https://vuepress.vuejs.org/config/#serviceworker)
+- [Google Analytics Integration](https://vuepress.vuejs.org/config/#ga)
+- [Multi-Language Support](https://vuepress.vuejs.org/guide/i18n.html)
 - A default theme with:
   - Responsive layout
   - Optional Homepage
-  - Automatic basic typeahead search
+  - [Automatic basic typeahead search](https://vuepress.vuejs.org/default-theme-config/#built-in-search)
+  - [Algolia Search](https://vuepress.vuejs.org/default-theme-config/#algolia-search)
   - Customizable navbar and sidebar
   - Auto-generated GitHub link and page edit links
 
@@ -44,4 +51,4 @@ yarn dev # serves VuePress' own docs with itself
 
 ## License
 
-MIT
+[MIT](https://github.com/vuejs/vuepress/blob/master/LICENSE)

docs/default-theme-config/README.md

@@ -321,6 +321,14 @@ module.exports = {
 }
 ```
 
+You can also hide the edit link on a specific page via `YAML front matter`:
+
+``` yaml
+---
+editLink: false
+---
+```
+
 ## Simple CSS Override
 
 If you wish to apply simple overrides to the styling of the default theme, you can create an `.vuepress/override.styl` file. This is a [Stylus](http://stylus-lang.com/) file but you can use normal CSS syntax as well.

docs/guide/custom-themes.md

@@ -28,6 +28,7 @@ This is the value of `$site` of this very website:
   "base": "/",
   "pages": [
     {
+      "lastModified": 1524027677,
       "path": "/",
       "title": "VuePress",
       "frontmatter": {}
@@ -43,7 +44,8 @@ This is the `$page` object for this page you are looking at:
 
 ``` json
 {
-  "path": "/custom-themes.html",
+  "lastModified": 1524847549,
+  "path": "/guide/custom-themes.html",
   "title": "Custom Themes",
   "headers": [/* ... */],
   "frontmatter": {}
@@ -54,6 +56,10 @@ If the user provided `themeConfig` in `.vuepress/config.js`, it will also be ava
 
 Finally, don't forget that `this.$route` and `this.$router` are also available as part of Vue Router's API.
 
+::: tip
+  `lastModified` is the UNIX timestamp of this file's last git commit, so please ensure you have git installed.
+:::
+
 ## Content Excerpt
 
 If a markdown file contains a `<!-- more -->` comment, any content above the comment will be extracted and exposed as `$page.excerpt`. If you are building custom theme for blogging, this data can be used to render a post list with excerpts.

docs/guide/deploy.md

@@ -20,7 +20,7 @@ The following guides are based on a few shared assumptions:
 
    If you are deploying to `https://<USERNAME>.github.io/`, you can omit `base` as it defaults to `"/"`.
 
-   If your are deploying to `https://<USERNAME>.github.io/<REPO>/`, (i.e. your repository is at `https://github.com/<USERNAME>/REPO>`), set `base` to `"/<REPO>/"`.
+   If your are deploying to `https://<USERNAME>.github.io/<REPO>/`, (i.e. your repository is at `https://github.com/<USERNAME>/<REPO>`), set `base` to `"/<REPO>/"`.
 
 2. Inside your project, create `deploy.sh` with the following content (with highlighted lines uncommented appropriately) and run it to deploy:
 
@@ -62,7 +62,7 @@ You can also run the above script in your CI setup to enable automatic deploymen
 
    If you are deploying to `https://<USERNAME or GROUP>.gitlab.io/`, you can omit `base` as it defaults to `"/"`.
 
-   If your are deploying to `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`, (i.e. your repository is at `https://gitlab.com/<USERNAME>/REPO>`), set `base` to `"/<REPO>/"`.
+   If your are deploying to `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`, (i.e. your repository is at `https://gitlab.com/<USERNAME>/<REPO>`), set `base` to `"/<REPO>/"`.
 
 2. Set `dest` in `.vuepress/config.js` to `public`.
 

docs/guide/using-vue.md

@@ -128,7 +128,7 @@ Make sure a custom component's name either contains a hyphen or is in PascalCase
 
 ### Using Pre-processors
 
-VuePress has built-in webpack config for the following pre-processors: `sass`, `scss`, `less`, `stylus` and `pug`. All you need to do is installing the corresposnding dependencies. For example, to enable `sass`, install the following in your project:
+VuePress has built-in webpack config for the following pre-processors: `sass`, `scss`, `less`, `stylus` and `pug`. All you need to do is installing the corresponding dependencies. For example, to enable `sass`, install the following in your project:
 
 ``` bash
 yarn add -D sass-loader node-sass

docs/zh/default-theme-config/README.md

@@ -52,7 +52,7 @@ module.exports = {
 }
 ```
 
-当你提供了一个 `items` 数组而不是一个单一的 `link` 时，它将会显示以 `下拉列表` 的方式显示：
+当你提供了一个 `items` 数组而不是一个单一的 `link` 时，它将显示为一个 `下拉列表` ：
 
 ```js
 module.exports = {
@@ -317,6 +317,14 @@ module.exports = {
 }
 ```
 
+你可以通过 `YAML front matter` 来禁用指定页面的编辑链接：
+
+``` yaml
+---
+editLink: false
+---
+```
+
 ## 简单的 CSS 覆盖
 
 如果你只是希望应用一些简单的 overrides 到默认主题的样式上，你可以创建一个 `.vuepress/override.styl` 文件，这是一个 [Stylus](http://stylus-lang.com/) 文件，但是你仍然可以使用普通的 CSS 语法。

docs/zh/guide/custom-themes.md

@@ -28,6 +28,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
   "base": "/",
   "pages": [
     {
+      "lastModified": 1524027677,
       "path": "/",
       "title": "VuePress",
       "frontmatter": {}
@@ -43,6 +44,7 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
 
 ``` json
 {
+  "lastModified": 1524847549,
   "path": "/custom-themes.html",
   "title": "自定义主题",
   "headers": [/* ... */],
@@ -54,6 +56,10 @@ VuePress 使用单文件组件来构建自定义主题。想要开发一个自
 
 最后，别忘了，作为 Vue Router API 的一部分，`this.$route` 和 `this.$router` 同样可以使用。
 
+::: tip 提示
+  `lastModified` 是这个文件最后一次 git 提交的 unix 时间戳，所以请确保你已经安装了 git。
+:::
+
 ## 内容摘抄
 
 如果一个 markdown 文件中有一个 `<!-- more -->` 注释，则该注释之前的内容会被抓取并暴露在 `$page.excerpt` 属性中。如果你在开发一个博客主题，你可以用这个属性来渲染一个带摘抄的文章列表。

docs/zh/guide/deploy.md

@@ -20,7 +20,7 @@
 
    如果你打算发布到 `https://<USERNAME>.github.io/`，则可以省略这一步，因为 `base` 默认即是 `"/"`。
 
-   如果你打算发布到 `https://<USERNAME>.github.io/<REPO>/`（也就是说你的仓库在 `https://github.com/<USERNAME>/REPO>`），则将 `base` 设置为 `"/<REPO>/"`。
+   如果你打算发布到 `https://<USERNAME>.github.io/<REPO>/`（也就是说你的仓库在 `https://github.com/<USERNAME>/<REPO>`），则将 `base` 设置为 `"/<REPO>/"`。
 
 2. 在你的项目中，创建一个如下的 `deploy.sh` 文件（请自行判断去掉高亮行的注释）:
 
@@ -62,7 +62,7 @@ cd -
 
    如果你打算发布到 `https://<USERNAME or GROUP>.gitlab.io/`，则可以省略这一步，因为 `base` 默认即是 `"/"`。
 
-   如果你打算发布到 `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`（也就是说你的仓库在 `https://gitlab.com/<USERNAME>/REPO>`），则将 `base` 设置为 `"/<REPO>/"`。
+   如果你打算发布到 `https://<USERNAME or GROUP>.gitlab.io/<REPO>/`（也就是说你的仓库在 `https://gitlab.com/<USERNAME>/<REPO>`），则将 `base` 设置为 `"/<REPO>/"`。
 
 2. 在 `.vuepress/config.js` 中将 `dest` 设置为 `public`。
 3. 在你项目的根目录下创建一个名为 `.gitlab-ci.yml` 的文件，无论何时你提交了更改，它都会帮助你自动构建和部署：

lib/app/app.js

@@ -3,7 +3,7 @@ import Router from 'vue-router'
 import Content from './Content'
 import ClientOnly from './ClientOnly'
 import dataMixin from './dataMixin'
-import NotFound from '@notFound'
+import store from './store'
 import { routes } from '@temp/routes'
 import { siteData } from '@temp/siteData'
 import enhanceApp from '@temp/enhanceApp'
@@ -41,12 +41,6 @@ Vue.prototype.$withBase = function (path) {
   }
 }
 
-// add 404 route
-routes.push({
-  path: '*',
-  component: NotFound
-})
-
 export function createApp () {
   const router = new Router({
     base: siteData.base,
@@ -57,7 +51,12 @@ export function createApp () {
       if (saved) {
         return saved
       } else if (to.hash) {
-        return false
+        if (store.disableScrollBehavior) {
+          return false
+        }
+        return {
+          selector: to.hash
+        }
       } else {
         return { x: 0, y: 0 }
       }

lib/app/store.js

@@ -0,0 +1,7 @@
+// It is not yet time to use Vuex to manage the global state
+// singleton object as a global store.
+const state = {
+  disableScrollBehavior: false
+}
+
+export default state

lib/build.js

@@ -21,6 +21,9 @@ module.exports = async function build (sourceDir, cliOptions = {}) {
   }
 
   const { outDir } = options
+  if (path.resolve() === outDir) {
+    return console.error(chalk.red('Unexpected option: outDir cannot be set to the current working directory.\n'))
+  }
   await fs.remove(outDir)
 
   let clientConfig = createClientConfig(options, cliOptions).toConfig()
@@ -103,6 +106,11 @@ module.exports = async function build (sourceDir, cliOptions = {}) {
           reject(new Error(`Failed to compile with errors.`))
           return
         }
+        if (cliOptions.debug && stats.hasWarnings()) {
+          stats.toJson().warnings.forEach(warning => {
+            console.warn(warning)
+          })
+        }
         resolve(stats.toJson({ modules: false }))
       })
     })

lib/default-theme/Layout.vue

@@ -28,6 +28,7 @@ import Navbar from './Navbar.vue'
 import Page from './Page.vue'
 import Sidebar from './Sidebar.vue'
 import { pathToComponentName } from '@app/util'
+import store from '@app/store'
 import { resolveSidebarItems } from './util'
 import throttle from 'lodash.throttle'
 
@@ -165,7 +166,7 @@ export default {
       const sidebarLinks = [].slice.call(document.querySelectorAll('.sidebar-link'))
       const anchors = [].slice.call(document.querySelectorAll('.header-anchor'))
         .filter(anchor => sidebarLinks.some(sidebarLink => sidebarLink.hash === anchor.hash))
-        
+
       const scrollTop = Math.max(window.pageYOffset, document.documentElement.scrollTop, document.body.scrollTop)
 
       for (let i = 0; i < anchors.length; i++) {
@@ -177,7 +178,13 @@ export default {
             (!nextAnchor || scrollTop < nextAnchor.parentElement.offsetTop - 10))
 
         if (isActive && this.$route.hash !== anchor.hash) {
-          this.$router.replace(anchor.hash)
+          store.disableScrollBehavior = true
+          this.$router.replace(anchor.hash, () => {
+            // execute after scrollBehavior handler.
+            this.$nextTick(() => {
+              store.disableScrollBehavior = false
+            })
+          })
           return
         }
       }

lib/default-theme/NavLink.vue

@@ -9,13 +9,13 @@
     v-else
     :href="link"
     class="nav-link"
-    :target="isMailto(link) ? null : '_blank'"
-    :rel="isMailto(link) ? null : 'noopener noreferrer'"
+    :target="isMailto(link) || isTel(link) ? null : '_blank'"
+    :rel="isMailto(link) || isTel(link) ? null : 'noopener noreferrer'"
   >{{ item.text }}</a>
 </template>
 
 <script>
-import { isExternal, isMailto, ensureExt } from './util'
+import { isExternal, isMailto, isTel, ensureExt } from './util'
 
 export default {
   props: {
@@ -30,7 +30,8 @@ export default {
   },
   methods: {
     isExternal,
-    isMailto
+    isMailto,
+    isTel
   }
 }
 </script>

lib/default-theme/NavLinks.vue

@@ -109,7 +109,7 @@ export default {
     &:hover, &.router-link-active
       color $accentColor
   .nav-item
-    cursor: pointer
+    cursor pointer
     position relative
     display inline-block
     margin-left 1.5rem

lib/default-theme/Page.vue

@@ -52,6 +52,9 @@ export default {
       }
     },
     editLink () {
+      if (this.$page.frontmatter.editLink === false) {
+        return
+      }
       const {
         repo,
         editLinks,

lib/default-theme/styles/code.styl

@@ -16,8 +16,6 @@
     border-radius 6px
     padding 1.25rem 1.5rem
     margin 0.85rem 0
-    white-space pre-wrap
-    word-break break-word
     overflow auto
     position relative
     code

lib/default-theme/styles/mobile.styl

@@ -21,9 +21,13 @@ $mobileSidebarWidth = $sidebarWidth * 0.82
     transition transform .2s ease
   .page
     padding-left 0
-  .theme-container.sidebar-open
-    .sidebar
-      transform translateX(0)
+  .theme-container
+    &.sidebar-open
+      .sidebar
+        transform translateX(0)
+    &.no-navbar
+      .sidebar
+        padding-top: 0
 
 // narrow mobile
 @media (max-width: $MQMobileNarrow)

lib/default-theme/styles/theme.styl

@@ -167,10 +167,14 @@ th, td
     .sidebar-mask
       display: block
   &.no-navbar
-    .content:not(.custom)
+    .content:not(.custom) >
       h1, h2, h3, h4, h5, h6
         margin-top 1.5rem
         padding-top 0
+    .sidebar
+      top 0
+    .custom-layout
+      padding-top 0
 
 
 @media (min-width: ($MQMobile + 1px))

lib/default-theme/util.js

@@ -1,7 +1,7 @@
 export const hashRE = /#.*$/
 export const extRE = /\.(md|html)$/
 export const endingSlashRE = /\/$/
-export const outboundRE = /^(https?:|mailto:)/
+export const outboundRE = /^(https?:|mailto:|tel:)/
 
 export function normalize (path) {
   return path
@@ -24,6 +24,10 @@ export function isMailto (path) {
   return /^mailto:/.test(path)
 }
 
+export function isTel (path) {
+  return /^tel:/.test(path)
+}
+
 export function ensureExt (path) {
   if (isExternal(path)) {
     return path

lib/markdown/highlight.js

@@ -17,6 +17,7 @@ module.exports = (str, lang) => {
   if (!lang) {
     return wrap(str, 'text')
   }
+  lang = lang.toLowerCase()
   const rawLang = lang
   if (lang === 'vue' || lang === 'html') {
     lang = 'markup'