Option API

name

  • 类型: string
  • 默认值: undefined

插件的名字。

在内部,VuePress 将会使用插件的包名作为插件的名称。当你你插件是一个本地插件(即直接使用了一个纯函数)时,请确保设定了该选项,这对调试更有利。

// .vuepress/config.js
module.exports = {
  plugins: [
    [
      (pluginOptions, context) => ({
        name: 'my-xxx-plugin'
        // ... the rest of options
      })
    ]
  ]
}

plugins

  • 类型: array
  • 默认值: undefined

一个插件可以像 preset 一样包含多个插件。

// 一个插件
module.exports = {
  plugins: [
    'tag',
    'category'
  ]
}

chainWebpack

  • 类型: Function
  • 默认值: undefined

使用 webpack-chain 来修改内部的 webpack 配置:

module.exports = {
  chainWebpack (config, isServer) {
    // config 是一个 ChainableConfig 的实例
  }
}

提示

由于 VuePress 是一个基于 Vue-SSR 的应用,这里会有两个 webpack 配置,isServer 用于决定当前的 webpack 配置是应用到 server 还是 client。

参考:

define

  • 类型: Object|Function
  • 默认值: undefined

由于通过 chainWebpack 使用 DefinePlugin 会有点麻烦:

module.exports = {
  chainWebpack (config) {
    config.plugin('injections').tap(([options]) => [
      Object.assign(options, {
        SW_BASE_URL: JSON.stringify('/')
      })
    ])
  }
}

VuePress 特别开辟了一个更简洁的 define 选项。值得注意的是这些值已自动地被 JSON.stringify 处理。

  • 对象式:
module.exports = {
  define: {
    SW_BASE_URL: '/',
  }
}
  • 函数式:
module.exports = (options, context) => ({
  define () {
    return {
      SW_BASE_URL: context.base || '/',
      SW_ENABLED: !!options.enabled,
    }
  }
})

alias

  • 类型: Object|Function
  • 默认值: undefined

我们可以通过 chainWebpack 来配置别名:

module.exports = (options, context) => ({
  chainWebpack (config) {
    config.resolve.alias.set('@theme', context.themePath)
  }
})

alias 可以使这个流程更像配置:

module.exports = (options, context) => ({
  alias: {
    '@theme': context.themePath
  }
})

enhanceDevServer

  • 类型: Function
  • 默认值: undefined

拓展 devServer 下层的 Koa app:

module.exports = {
  enhanceDevServer (app) {
    // ...
  }
}

一个简单的创建子 public 目录的插件如下:

const path = require('path')

module.exports = (options, context) => {
  const imagesAssetsPath = path.resolve(context.sourceDir, '.vuepress/images')

  return {
      // For development
      enhanceDevServer (app) {
        const mount = require('koa-mount')
        const serveStatic = require('koa-static')
        app.use(mount(path.join(context.base, 'images'), serveStatic(imagesAssetsPath)))
      },

      // For production
      async generated () {
        const { fs } = require('@vuepress/shared-utils')
        await fs.copy(imagesAssetsPath, path.resolve(context.outDir, 'images'))
      }
  }
}

extendMarkdown

  • 类型: Function
  • 默认值: undefined

一个函数,修改内部用于渲染 markdown 文件的 markdown-it 实例的配置、或者应用一些额外的插件:

module.exports = {
  extendMarkdown: md => {
    md.set({ breaks: true })
    md.use(require('markdown-it-xxx'))
  }
}

chainMarkdown

  • 类型: Function
  • 默认值: undefined

使用 markdown-it-chain 来修改内部的 markdown 配置。

module.exports = {
  chainMarkdown (config) {
    // 与 new MarkdownIt 的 'options' 互动
    // 参考: https://markdown-it.github.io/markdown-it/#MarkdownIt.new
    config
      .options
        .link(true)
        .breaks(true)

    // 修改内置插件的参数
    config
      .plugin('anchor')
        .tap(([options]) => [
          Object.assign(options, { permalinkSymbol: '#' })
        ])

    // 增加额外的插件
    config
      .plugin('sup')
        .use(require('markdown-it-sup'))

    // Remove internal plugin
    config.plugins.delete('snippet')
  }
}

参考:

enhanceAppFiles

  • 类型: String | Array | AsyncFunction
  • 默认值: undefined

此选项接受指向增强文件的绝对文件路径或返回该路径的函数,你可以通过此选项做一些应用级别的配置:

import { resolve } from 'path'

module.exports = {
  enhanceAppFiles: resolve(__dirname, 'client.js')
}

此选项还支持动态代码,允许你使用触摸编译上下文的能力来做更多的事:

module.exports = (option, context) => {
  return {
    enhanceAppFiles() {
      return {
         name: 'dynamic-code',
         content: `export default ({ Vue }) => { Vue.mixin('$source', '${
           context.sourceDir
         }') }`
       }
    }
  }
}

clientDynamicModules

  • 类型: Function
  • 默认值: undefined

有时,你可能想要在编译期间生成一些在客户端使用的模块:

module.exports = (options, context) => ({
  clientDynamicModules() {
    return {
      name: 'constants.js',
      content: `export const SOURCE_DIR = '${context.sourceDir}'`
    }
  }
})

然后你可以在客户端这样使用你的模块:

import { SOURCE_DIR } from '@dynamic/constants'

extendPageData

  • 类型: Function
  • 默认值: undefined

一个函数,用于拓展或者修改 $page 对象。这个函数将会在编译器为每个页面执行一次。

module.exports = {
  extendPageData ($page) {
    const {
      _filePath,           // 源文件的绝对路径
      _computed,           // 在构建期访问全局的计算属性,如:_computed.$localePath.
      _content,            // 源文件的原始内容字符串
      _strippedContent,    // 源文件剔除掉 frontmatter 的内容字符串
      key,                 // 页面唯一的 hash key
      frontmatter,         // 页面的 frontmatter 对象
      regularPath,         // 当前页面遵循文件层次结构的默认链接
      path,                // 当前页面的实际链接(在 permalink 不存在时,使用 regularPath )
    } = $page
   
    // 1. Add extra fields.
    page.xxx = 'xxx'
    
    // 2. Change frontmatter.
    frontmatter.sidebar = 'auto'
  }
}

注意

那些以 _ 开头的字段意味着你只能在编译期访问。

例子:

module.exports = {
  extendPageData ($page) {
    $page.size = ($page.content.length / 1024).toFixed(2) + 'kb'
  }
}

然后你可以在任意的 Vue 中通过 this.$page.size 来访问这个变量。

clientRootMixin

  • 类型: String
  • 默认值: undefined

指向 mixin 文件的路径,它让你你可以控制根组件的生命周期:

// 插件的入口
const path = require('path')

module.exports = {
  clientRootMixin: path.resolve(__dirname, 'mixin.js')
}
// mixin.js
export default {
  created () {},
  mounted () {}
}

additionalPages

  • 类型: Array|AsyncFunction
  • 默认值: undefined

增加一个指向某个 markdown 文件的页面:

const path = require('path')

module.exports = {
  additionalPages: [
    {
     path: '/readme/',
     filePath: path.resolve(__dirname, '../../README.md')
    }
  ]
}

或增加一个具有明确内容的页面:

module.exports = {
  async additionalPages () {
    // 注意 VuePress 没有任何内置的请求库,
    // 你需要自己安装它。
    const rp = require('request-promise')
    const content = await rp('https://raw.githubusercontent.com/vuejs/vuepress/master/CHANGELOG.md')
    return [
      {
        path: '/changelog/',
        content
      }
    ]
  }
}

或增加一个纯粹的路由:

module.exports = {
  additionalPages: [
    {
       path: '/alpha/',
       frontmatter: {
          layout: 'MyLayout'
       }
    }
  ]
}

globalUIComponents

  • 类型: Array|String
  • 默认值: undefined

你可能想注入某些全局的 UI,并固定在页面中的某处,如 back-to-top, popup。在 VuePress 中,**一个全局 UI 就是一个 Vue 组件。**你可以直接配置该全局组件的名称,如:

module.exports = {
  globalUIComponents: [
    'Component-1',
    'Component-2'
  ]
}

VuePress 将会自动将这些组件注入到布局组件的隔壁:

<div id="app">
  <div class="theme-container"> ... </div> <!-- Layout Component -->
  <div class="global-ui">
    <Component-1/>
    <Component-2/>
</div>
</div>

extendCli

  • 类型: function
  • 默认值: undefined

注册一个额外的 command 来增强 vuepress 的 CLI。这个函数将会以一个 CAC 的实例作为第一个参数被调用。

module.exports = {
  extendCli (cli) {
    cli
      .command('info [targetDir]', '')
      .option('--debug', 'display info in debug mode')
      .action((dir = '.') => {
        console.log('Display info of your website')
      })
  }
}

现在你可以在你项目中使用 vuepress info [targetDir] 了!

TIP

值得注意的是,一个自定义的 command 需要 VuePress 像 vuepress devvuepress build 去定位到你的站点配置,所以在开发一个 command 时,请确保引导用户去传入 targetDir 作为 CLI 参数的一部分。