From a842877f430da2dd1e0f90cac7c583c9c598598c Mon Sep 17 00:00:00 2001 From: maoyuyang Date: Sun, 12 May 2019 11:38:38 +0800 Subject: [PATCH] docs: add 'extraWatchFiles' option to the documentation --- packages/docs/docs/config/README.md | 17 +++++++++++++++++ packages/docs/docs/zh/config/README.md | 18 ++++++++++++++++++ 2 files changed, 35 insertions(+) diff --git a/packages/docs/docs/config/README.md b/packages/docs/docs/config/README.md index acd9ce2d75..ed47913467 100644 --- a/packages/docs/docs/config/README.md +++ b/packages/docs/docs/config/README.md @@ -113,6 +113,23 @@ vuepress dev docs --no-cache # remove cache before each build. ``` ::: +### extraWatchFiles + +- Type: `Array` +- Default: `[]` + +Specify extra files to be watched. + +You can watch any file if you want. File changes will trigger `vuepress` rebuilding and real-time updates. + +``` js +module.exports = { + extraWatchFiles: [ + '.vuepress/foo.js', // Relative path usage + '/path/to/bar.js' // Absolute path usage + ] +} +``` ## Styling diff --git a/packages/docs/docs/zh/config/README.md b/packages/docs/docs/zh/config/README.md index c874c65124..cd960af5fe 100644 --- a/packages/docs/docs/zh/config/README.md +++ b/packages/docs/docs/zh/config/README.md @@ -109,6 +109,24 @@ vuepress dev docs --no-cache # 在每次构建前删除 cache ``` ::: +### extraWatchFiles + +- 类型: `Array` +- 默认值: `[]` + +指定额外的需要被监听的文件。 + +你可以监听任何想监听的文件,文件变动将会触发 `vuepress` 重新构建,并实时更新。 + +``` js +module.exports = { + extraWatchFiles: [ + '.vuepress/foo.js', // 使用相对路径 + '/path/to/bar.js' // 使用绝对路径 + ] +} +``` + ## Styling ### palette.styl