docs: 更新文档 (#875)

Signed-off-by: unknowIfGuestInDream <liang.tang.cx@gmail.com>
unknowIfGuestInDream · Oct 28, 2023 · 588a783 · 588a783
1 parent 76129b4
commit 588a783
Show file tree

Hide file tree

Showing 19 changed files with 1,160 additions and 30 deletions.
diff --git a/cg/pom.xml b/cg/pom.xml
@@ -36,6 +36,7 @@
         <version>1.0.0</version>
     </parent>
     <artifactId>javafxTool-cg</artifactId>
+    <version>1.0.0</version>
     <name>javafxTool-cg</name>
     <packaging>jar</packaging>
     <description>cg开发工具组件</description>

diff --git a/common/pom.xml b/common/pom.xml
@@ -36,6 +36,7 @@
     </parent>
     <modelVersion>4.0.0</modelVersion>
     <artifactId>javafxTool-common</artifactId>
+    <version>1.0.0</version>
     <name>javafxTool-common</name>
     <packaging>jar</packaging>
     <description>common组件</description>

diff --git a/core/pom.xml b/core/pom.xml
@@ -36,6 +36,7 @@
         <version>1.0.0</version>
     </parent>
     <artifactId>javafxTool-core</artifactId>
+    <version>1.0.0</version>
     <name>javafxTool-core</name>
     <packaging>jar</packaging>
     <description>javafxTool 核心组件</description>

diff --git a/docs/README.md b/docs/README.md
@@ -34,7 +34,3 @@ JavaFXTool基于JDK17 + JavaFX17 + controlsfx 11.x.x + maven构建的javafx脚
 | pdfviewfx              | 3.0.0      | PDF视图工具                        |
 | preferencesfx          | 11.16.0    | 为应用程序设置/首选项创建 UI 的框架           |
 | yuicompressor          | 2.4.8      | JS/CSS压缩工具                     |
-
-## 项目地址
-- github地址：[https://github.com/unknowIfGuestInDream/javafxTool](https://github.com/unknowIfGuestInDream/javafxTool ':target=_blank')
-- gitee地址：[https://gitee.com/unknowIfGuestInDream/javafxTool](https://gitee.com/unknowIfGuestInDream/javafxTool ':target=_blank')
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -1,6 +1,13 @@
 - Overview
-  - [介绍](overview/Into.md)
-  - [环境](overview/Env.md)
+    - [介绍](overview/Into.md)
+    - [环境](overview/Env.md)
+    - [发布日志](overview/Changelog.md)
+
+- Develop
+    - [功能介绍](develop/Into.md)
+    - [SPI接口](develop/Interface.md)
+    - [注意事项](develop/Note.md)
+    - [打包](develop/Package.md)
 
 - Examples
     - Smc

diff --git a/docs/develop/Interface.md b/docs/develop/Interface.md
@@ -0,0 +1,22 @@
+> SPI接口
+
+- core
+    1. TemplateLoaderService: freemarker TemplateLoader加载，子类实现以添加子模块的模板路径
+    2. GroovyLoaderService: Groovy脚本路径加载，子类实现添加子模块脚本路径
+- frame
+    1. FXSamplerProject: project信息，包含project名，模块，包名，欢迎页等
+    2. MenubarConfigration: 菜单栏配置
+    3. FXSamplerConfiguration: 项目style, title和icon配置
+    4. CenterPanelService: 中心区域的Node配置, 包含点击和切换组件时的接口
+    5. SplashScreen: 闪屏支持
+    6. SamplePostProcessorService: Sample资源后置处理
+    7. VersionCheckerService: 版本更新检查
+    8. SamplesTreeViewConfiguration: 菜单树配置
+- login
+    1. LoginCheck: 登录校验
+
+## 版本更新
+
+## freemarker
+
+## groovy
diff --git a/docs/develop/Into.md b/docs/develop/Into.md
@@ -0,0 +1,5 @@
+## main window
+
+## toolbar menu
+
+## javafx工具包介绍
diff --git a/docs/develop/Note.md b/docs/develop/Note.md
@@ -0,0 +1,5 @@
+## 依赖更新
+
+## 发布版本
+
+## main直接调用
diff --git a/docs/develop/Package.md b/docs/develop/Package.md
@@ -0,0 +1,3 @@
+## Maven打包
+
+## IDEA打包
diff --git a/docs/images/overview/env/eclipse_import.png b/docs/images/overview/env/eclipse_import.png
diff --git a/docs/images/overview/env/eclipse_maven_setting.png b/docs/images/overview/env/eclipse_maven_setting.png
diff --git a/docs/images/overview/env/idea_maven_setting.png b/docs/images/overview/env/idea_maven_setting.png
diff --git a/docs/index.html b/docs/index.html
@@ -59,7 +59,7 @@
 <div id="app"></div>
 <script>
   window.$docsify = {
-    themeColor: '#429db9',//主题颜色
+      themeColor: '#4471A9FF',//主题颜色
     homepage: '../README.md',
     // 项目名称
     name: 'JavaFXTool',
@@ -77,10 +77,12 @@
     // 最大支持渲染的标题层级
     maxLevel: 4,
     // 自定义侧边栏后默认不会再生成目录，设置生成目录的最大层级，建议配置为1或者2
-    subMaxLevel: 2,
+      subMaxLevel: 3,
     alias: {
       '/overview/(.*)':
           '../overview/$1',
+        '/develop/(.*)':
+            '../develop/$1',
       '/smc/(.*)':
               '../smc/$1',
       '/qe/(.*)':
@@ -104,7 +106,7 @@
       noData: '找不到结果',
       depth: 4,
       hideOtherSidebarContent: false,
-      namespace: 'website-1',
+        namespace: 'website-2',
     },
     count: {
       countable: true,

diff --git a/docs/overview/Changelog.md b/docs/overview/Changelog.md