Skip to content

doc: add 'extraWatchFiles' option to the documentation #1593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions packages/docs/docs/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 18 additions & 0 deletions packages/docs/docs/zh/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down