docs: 简化使用文档

README.md

@@ -27,7 +27,7 @@
 <img src="https://img.shields.io/badge/license-Apache-blue"/>
 <a href="http://liangjingkanji.github.io/BRV/updates"><img src="https://img.shields.io/badge/changed-%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97-brightgreen"/></a>
 <a href="http://liangjingkanji.github.io/BRV/api"><img src="https://img.shields.io/badge/api-%E5%87%BD%E6%95%B0%E6%96%87%E6%A1%A3-red"/></a>
-<img src="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group.svg"/>
+<a href="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group-qrcode.png"><img src="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group.svg"/></a>
 <a href="https://github.com/liangjingkanji/BRV/blob/master/docs/issues.md"><img src="https://raw.githubusercontent.com/liangjingkanji/Net/master/docs/img/issues.svg"/></a>
 </p>
 

docs/index.md

@@ -180,9 +180,14 @@ rv.linear().setup {
 
 别看文档中DataBinding方式复杂, 实际代码量最少, 同时最解耦
 
-> 使用DataBinding可以复制或者引用我的常用自定义属性:  [DataBindingComponent.kt](https://github.com/liangjingkanji/Engine/blob/master/engine/src/main/java/com/drake/engine/databinding/DataBindingComponent.kt)<br>
->
-如果你想更加了解DataBinding请阅读[DataBinding最全使用说明](https://juejin.cn/post/6844903549223059463/)<br>
-> 如果项目为多Module组件化, 请保证主Module及使用DataBinding的Module都有开启DataBinding/Kapt插件(
-> 否则NoClassDefFoundError找不到BR类)
+!!! Bug "组件化项目"
+多Module组件化项目要求主Module及使用DataBinding的Module都开启DataBinding及Kapt,
+否则抛出NoClassDefFoundError找不到BR类
+
+!!! quote "DataBinding"
+使用DataBinding可以复制或者引用我的常用自定义属性:  [DataBindingComponent.kt](https://github.com/liangjingkanji/Engine/blob/master/engine/src/main/java/com/drake/engine/databinding/DataBindingComponent.kt) <br>
+如果想更了解DataBinding可以阅读一篇文章: [DataBinding最全使用说明](https://juejin.cn/post/6844903549223059463/)
+
+
+
 

docs/issues.md

@@ -1,4 +1,6 @@
-## 常见问题
+BRV基于RecyclerView的组件进行扩展完善, 不影响原有功能可自行扩展实现
+
+<br>
 
 - [java 上可以用吗?](https://github.com/liangjingkanji/BRV/issues/180)
 - [由dataclass导致的分组折叠崩溃](https://github.com/liangjingkanji/BRV/issues/79)
@@ -17,4 +19,11 @@
 - [上拉加载多语言的问题](https://github.com/liangjingkanji/BRV/issues/212)
 - [第一页加载项没有占满整个页面时，自动加载第二页](https://github.com/liangjingkanji/BRV/issues/206)
 - [上拉加载时会把顶部布局顶出去](https://github.com/liangjingkanji/BRV/issues/192)
-- [请教侧滑背景实现思路](https://github.com/liangjingkanji/BRV/issues/158)
+- [请教侧滑背景实现思路](https://github.com/liangjingkanji/BRV/issues/158)
+
+## 开发者交流
+
+- [反馈问题](https://github.com/liangjingkanji/BRV/issues)
+- [其他开发者提及问题](https://github.com/liangjingkanji/BRV/issues)
+- [交流社区](https://github.com/liangjingkanji/BRV/discussions)
+- <a href="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group-qrcode.png"><img src="https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group.svg"/></a>

docs/refresh.md

@@ -146,6 +146,7 @@ PageRefreshLayout内嵌`StateLayout`同时具备显示缺省页的能力
 | showError | 显示错误缺省页 |
 | showContent | 显示内容页 |
 
+如果你使用`showXX()`方法更改缺省页状态, 并不需要再调用`finishXX()`等方法
 
 #### 全局缺省页配置
 

mkdocs.yml

@@ -27,24 +27,33 @@ theme:
     - search.suggest
     - search.share
     - content.code.copy
+    - content.code.annotate
 plugins:
   - offline
   - search:
       separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
       lang:
         - en
         - zh
-
 markdown_extensions:
+  - attr_list
+  - def_list
+  - md_in_html
   - toc:
       permalink: true
   - pymdownx.tasklist:
       custom_checkbox: true
   - admonition
+  - pymdownx.highlight
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.inlinehilite
-  - pymdownx.tabbed
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.caret
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.tilde
 
 nav:
   - 使用: index.md
@@ -78,7 +87,7 @@ nav:
   - 网络请求: net.md
   - ViewBinding: view-binding.md
   - 社区讨论: https://github.com/liangjingkanji/BRV/discussions
-  - 常见问题: https://github.com/liangjingkanji/BRV/blob/master/docs/issues.md
+  - 常见问题: issues.md
   - 第三方组件: component.md
   - 更新日志: updates.md
   - 1.x文档: api/index.html