Skip to content

Commit bd2657e

Browse files
committed
docs: add comments for client config file path (close #1237)
1 parent 3ff1b06 commit bd2657e

File tree

2 files changed

+3
-0
lines changed

2 files changed

+3
-0
lines changed

docs/reference/default-theme/extending.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ export const childTheme = (options: DefaultThemeOptions): Theme => {
100100
extends: defaultTheme(options),
101101

102102
// override layouts in child theme's client config file
103+
// notice that you would build ts to js before publishing to npm,
104+
// so this should be the path to the js file
103105
clientConfigFile: path.resolve(__dirname, './client.js'),
104106

105107
// override component alias

docs/zh/reference/default-theme/extending.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@ export const childTheme = (options: DefaultThemeOptions): Theme => {
100100
extends: defaultTheme(options),
101101

102102
// 在子主题的客户端配置文件中覆盖布局
103+
// 注意,你在发布到 NPM 之前会将 TS 构建为 JS ,因此这里需要设置为 JS 文件的路径
103104
clientConfigFile: path.resolve(__dirname, './client.js'),
104105

105106
// 覆盖组件别名

0 commit comments

Comments
 (0)