docs: add comments for client config file path (close #1237)

vuepress · Jul 11, 2023 · bd2657e · bd2657e
1 parent 3ff1b06
commit bd2657e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/reference/default-theme/extending.md b/docs/reference/default-theme/extending.md
@@ -100,6 +100,8 @@ export const childTheme = (options: DefaultThemeOptions): Theme => {
     extends: defaultTheme(options),
 
     // override layouts in child theme's client config file
+    // notice that you would build ts to js before publishing to npm,
+    // so this should be the path to the js file
     clientConfigFile: path.resolve(__dirname, './client.js'),
 
     // override component alias

diff --git a/docs/zh/reference/default-theme/extending.md b/docs/zh/reference/default-theme/extending.md
@@ -100,6 +100,7 @@ export const childTheme = (options: DefaultThemeOptions): Theme => {
     extends: defaultTheme(options),
 
     // 在子主题的客户端配置文件中覆盖布局
+    // 注意，你在发布到 NPM 之前会将 TS 构建为 JS ，因此这里需要设置为 JS 文件的路径
     clientConfigFile: path.resolve(__dirname, './client.js'),
 
     // 覆盖组件别名