docs: 优化使用文档

liangjingkanji · Aug 3, 2023 · a3a2b04 · a3a2b04
1 parent 9d58f71
commit a3a2b04
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 11 deletions.
diff --git a/docs/css/extra.css b/docs/css/extra.css
@@ -43,5 +43,5 @@ code,
 .md-nav,
 .md-typeset code,
 .md-typeset {
-    font-size: 14px;
+    font-size: 14px !important;
 }
diff --git a/docs/index.md b/docs/index.md
@@ -1,14 +1,14 @@
 本框架使用Android主流的Http框架OkHttp作为请求内核, 遵守不影响OkHttp原有的函数组件使用原则开发
 
 <br>
-<p align="center"><strong>STAR/分享可以让更多人参与到本开源项目, 点击文档右上角小铅笔可直接修订文档 ↗</strong></p>
+<p align="center"><strong>STAR/分享可以让更多人参与到本开源项目</strong></p>
 <br>
 
 
 !!! tip "前言"
 
     - Net没有的功能可以搜索`"OkHttp如何XX"`来实现
-    - 强烈建议下载仓库运行sample项目来学习/实践
+    - 推荐下载示例代码结合学习
     - 如果觉得文档看不懂那肯定是作者问题, 请反馈给作者或者自我修订
 
 ## 使用
@@ -79,4 +79,15 @@ scopeNetLife {
 | Response | 最基础的响应 |
 | File | 文件对象, 这种情况其实应当称为[下载文件](download-file.md) |
 
-详细查看[转换器](customizer-converter.md), 非以上类型要求[自定义转换器](customizer-converter.md)
+```kotlin
+scopeNetLife {
+    val file = Get<File>(Api.FILE).await()
+}
+```
+
+详细查看[转换器](customizer-converter.md), 非以上类型要求[自定义转换器](customizer-converter.md)
+
+---
+[下载Apk](https://github.com/liangjingkanji/Net/releases/latest/download/net-sample.apk){ .md-button }
+[下载源码](https://github.com/liangjingkanji/Net.git){ .md-button }
+[示例代码](https://github.com/liangjingkanji/Net/tree/master/sample/src/main/java/com/drake/net/sample/ui/fragment){ .md-button }
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,16 +1,21 @@
 site_name: Net
-site_author: drake
 site_description: Net document
-copyright: Copyright &copy; 2018 - 2023 劉強東
-
-repo_name: GitHub
 repo_url: https://github.com/liangjingkanji/Net
 
+site_author: 劉強東
+copyright: Copyright &copy; 2018 - 2020 劉強東
+repo_name: GitHub
+docs_dir: 'docs'
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/
+    - icon: fontawesome/brands/qq
+      link: https://raw.githubusercontent.com/liangjingkanji/liangjingkanji/master/img/group-qrcode.png
+    - icon: fontawesome/brands/twitch
+      link: https://github.com/liangjingkanji/Net/discussions
 extra_css:
   - css/extra.css
-
-docs_dir: docs
-
 theme:
   name: material
   custom_dir: docs/material
@@ -23,6 +28,10 @@ theme:
   font: false
   language: zh
   features:
+    - navigation.top
+    - navigation.prune
+    - navigation.footer
+    - navigation.instant
     - search.highlight
     - search.suggest
     - search.share