diff --git a/docs/en/guide/getting-started.md b/docs/en/guide/getting-started.md index 5d7cd27..6258c9c 100644 --- a/docs/en/guide/getting-started.md +++ b/docs/en/guide/getting-started.md @@ -18,7 +18,13 @@ Create the `smart-doc.json` file in the `resources` directory of the module wher > `outPath` can also use relative paths, such as: `./src/main/resources/static/doc` -Configure the `Maven plug-in` in the `pom.xml` file of the module where the project startup class is located. Note: the source code package that `includes` depends on is required. +Configure the `Maven plug-in` in the `pom.xml` file of the module where the project startup class is located. + +:::tip +Note: the source code package that `includes` depends on is required. +::: + + ```xml com.ly.smart-doc @@ -49,7 +55,7 @@ Configure the `Maven plug-in` in the `pom.xml` file of the module where the proj ``` -> `includes` needs to be adjusted to configure `groupId:artifactId` for the packages that the project module depends on, and supports regular `artifactId:*` +> `includes` needs to be adjusted to configure `groupId:artifactId` for the packages that the project module depends on, and supports regular `groupId:*` If the project depends on other internal public modules and second-party packages, the dependent packages need to be configured with source code packaging. diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md index 1f0bca2..636dd9e 100644 --- a/docs/zh/guide/getting-started.md +++ b/docs/zh/guide/getting-started.md @@ -18,7 +18,12 @@ > `outPath`也可以使用相对路径, 如: `./src/main/resources/static/doc` -在项目启动类所在模块的`pom.xml`文件配置`Maven插件`, 注意: 需要`includes`依赖的源码包 +在项目启动类所在模块的`pom.xml`文件配置`Maven插件` + +:::tip +注意: 需要`includes`依赖的源码包 +::: + ```xml com.ly.smart-doc