From 1a72945d6030ed249aec8710fda10cd9bca0c5b0 Mon Sep 17 00:00:00 2001
From: shengzhang <2393584716@qq.com>
Date: Tue, 15 Dec 2020 01:06:12 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BC=98=E5=8C=96readme.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 82 ++++++++++++++++++++++++++------------
sa-token-doc/doc/README.md | 76 +++++++++++++++++++++++------------
sa-token-doc/doc/index.css | 20 ++++++++++
3 files changed, 127 insertions(+), 51 deletions(-)
diff --git a/README.md b/README.md
index 4b60cfb6..3660cd83 100644
--- a/README.md
+++ b/README.md
@@ -2,57 +2,87 @@
sa-token v1.4.0
-一个JavaWeb权限认证框架，强大、简单、好用
+一个JavaWeb轻量级权限认证框架，功能全面，上手简单
+ 
- 
-
-## sa-token 😋
-- 在线文档：[http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
-- 需求提交：我们深知一个优秀的项目需要海纳百川，[点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
-- 开源不易，求鼓励，**点个`star`吧**
-## 框架优点
-与其它权限认证框架相比，sa-token尽力保证两点：
+---
+
+
+## 😘 在线资料
+- ##### ⚡ 官网首页：[http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
+- ##### ⚡ 在线文档：[http://sa-token.dev33.cn/doc/index.html](http://sa-token.dev33.cn/doc/index.html)
+- ##### ⚡ 需求提交：[我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
+- ##### ⚡ 开源不易，求鼓励，点个star吧
+
+
+## ⭐ sa-token是什么？
+- **sa-token是一个JavaWeb轻量级权限认证框架，其API调用非常简单，有多简单呢？以登录验证为例，你只需要：**
+``` java
+// 在登录时写入当前会话的账号id
+StpUtil.setLoginId(10001);
+```
+
+
+- **然后在任意需要验证登录权限的地方：**
+``` java
+// 检测是否登录 --- 如果当前会话未登录，下面这句代码会抛出 `NotLoginException`异常
+StpUtil.checkLogin();
+```
+
+
+- **没有复杂的封装！不要任何的配置！先写入，后鉴权！只需这两行简单的调用，即可轻松完成系统登录鉴权！**
+
+
+## 🔥 框架设计思想
+与其它权限认证框架相比，`sa-token`尽力保证两点：
- 上手简单：能自动化的配置全部自动化，不让你费脑子
- 功能强大：能涵盖的功能全部涵盖，不让你用个框架还要自己给框架打各种补丁
-## 涵盖功能
-- 登录验证
-- 权限验证
-- 自定义session会话
-- 踢人下线
-- 模拟他人账号
-- 持久层扩展（集成redis）
-- 多账号认证体系（比如一个商城项目的user表和admin表）
-- 无cookie模式（APP、小程序等前后台分离场景）
-- 注解式鉴权（优雅的将鉴权与业务代码分离）
-- 零配置与Spring等框架集成
-- ...
-## 贡献代码
+## 💦️️ 涵盖功能
+- ⚡ **登录验证** —— 轻松登录鉴权，提供个性化登录提示
+- ⚡ **权限验证** —— 拦截违规调用，不同角色不同授权
+- ⚡ **自定义session会话** —— 专业的数据缓存中心
+- ⚡ **踢人下线** —— 将违规用户立刻清退下线
+- ⚡ **模拟他人账号** —— 实时操作任意用户状态数据
+- ⚡ **持久层扩展** —— 可集成redis、MongoDB等专业缓存中间件
+- ⚡ **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
+- ⚡ **无cookie模式** —— APP、小程序等前后台分离场景
+- ⚡ **注解式鉴权** —— 优雅的将鉴权与业务代码分离
+- ⚡ **组件自动注入** —— 零配置与Spring等框架集成
+- ⚡ **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
+
+
+## 🔨 贡献代码
+sa-token欢迎大家贡献代码，为框架添砖加瓦
1. 在github上fork一份到自己的仓库
2. clone自己的仓库到本地电脑
3. 在本地电脑修改、commit、push
4. 提交pr（点击：New Pull Request）
5. 等待合并
-## 建议贡献的地方
+
+## 🌱 建议贡献的地方
- 修复源码现有bug，或增加新的实用功能
- 完善在线文档，或者修复现有错误之处
- 更多demo示例：比如SSM版搭建步骤
+- 您可以参考项目issues与需求墙进行贡献
- 如果更新实用功能，可在文档友情链接处留下自己的推广链接
-## 优秀项目链接
-[**okhttps** —— 一个轻量级http通信框架，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
-## 交流群
+## 🚀 友情链接
+[**[ okhttps ]** 一个轻量级http通信框架，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
+
+
+## 😎 交流群
QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) ，欢迎你的加入
diff --git a/sa-token-doc/doc/README.md b/sa-token-doc/doc/README.md
index 1afe2ad7..3660cd83 100644
--- a/sa-token-doc/doc/README.md
+++ b/sa-token-doc/doc/README.md
@@ -14,49 +14,75 @@
---
-
-## sa-token 😋
-- 在线文档：[http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
-- 需求提交：我们深知一个优秀的项目需要海纳百川，[点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
-- 开源不易，求鼓励，**点个`star`吧**
-## 框架优点
-与其它权限认证框架相比，sa-token尽力保证两点：
+
+## 😘 在线资料
+- ##### ⚡ 官网首页：[http://sa-token.dev33.cn/](http://sa-token.dev33.cn/)
+- ##### ⚡ 在线文档：[http://sa-token.dev33.cn/doc/index.html](http://sa-token.dev33.cn/doc/index.html)
+- ##### ⚡ 需求提交：[我们深知一个优秀的项目需要海纳百川，点我在线提交需求](http://sa-app.dev33.cn/wall.html?name=sa-token)
+- ##### ⚡ 开源不易，求鼓励，点个star吧
+
+
+## ⭐ sa-token是什么？
+- **sa-token是一个JavaWeb轻量级权限认证框架，其API调用非常简单，有多简单呢？以登录验证为例，你只需要：**
+``` java
+// 在登录时写入当前会话的账号id
+StpUtil.setLoginId(10001);
+```
+
+
+- **然后在任意需要验证登录权限的地方：**
+``` java
+// 检测是否登录 --- 如果当前会话未登录，下面这句代码会抛出 `NotLoginException`异常
+StpUtil.checkLogin();
+```
+
+
+- **没有复杂的封装！不要任何的配置！先写入，后鉴权！只需这两行简单的调用，即可轻松完成系统登录鉴权！**
+
+
+## 🔥 框架设计思想
+与其它权限认证框架相比，`sa-token`尽力保证两点：
- 上手简单：能自动化的配置全部自动化，不让你费脑子
- 功能强大：能涵盖的功能全部涵盖，不让你用个框架还要自己给框架打各种补丁
-## 涵盖功能
-- 登录验证
-- 权限验证
-- 自定义session会话
-- 踢人下线
-- 模拟他人账号
-- 持久层扩展（集成redis）
-- 多账号认证体系（比如一个商城项目的user表和admin表）
-- 无cookie模式（APP、小程序等前后台分离场景）
-- 注解式鉴权（优雅的将鉴权与业务代码分离）
-- 零配置与Spring等框架集成
-- ...
-## 贡献代码
+## 💦️️ 涵盖功能
+- ⚡ **登录验证** —— 轻松登录鉴权，提供个性化登录提示
+- ⚡ **权限验证** —— 拦截违规调用，不同角色不同授权
+- ⚡ **自定义session会话** —— 专业的数据缓存中心
+- ⚡ **踢人下线** —— 将违规用户立刻清退下线
+- ⚡ **模拟他人账号** —— 实时操作任意用户状态数据
+- ⚡ **持久层扩展** —— 可集成redis、MongoDB等专业缓存中间件
+- ⚡ **多账号认证体系** —— 比如一个商城项目的user表和admin表分开鉴权
+- ⚡ **无cookie模式** —— APP、小程序等前后台分离场景
+- ⚡ **注解式鉴权** —— 优雅的将鉴权与业务代码分离
+- ⚡ **组件自动注入** —— 零配置与Spring等框架集成
+- ⚡ **更多功能正在集成中...** —— 如有您有好想法或者建议，欢迎加群交流
+
+
+## 🔨 贡献代码
+sa-token欢迎大家贡献代码，为框架添砖加瓦
1. 在github上fork一份到自己的仓库
2. clone自己的仓库到本地电脑
3. 在本地电脑修改、commit、push
4. 提交pr（点击：New Pull Request）
5. 等待合并
-## 建议贡献的地方
+
+## 🌱 建议贡献的地方
- 修复源码现有bug，或增加新的实用功能
- 完善在线文档，或者修复现有错误之处
- 更多demo示例：比如SSM版搭建步骤
+- 您可以参考项目issues与需求墙进行贡献
- 如果更新实用功能，可在文档友情链接处留下自己的推广链接
-## 优秀项目链接
-[**okhttps** —— 一个轻量级http通信框架，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
+
+## 🚀 友情链接
+[**[ okhttps ]** 一个轻量级http通信框架，支持 WebSocket 以及 Stomp 协议](https://gitee.com/ejlchina-zhxu/okhttps)
-
-## 交流群
+## 😎 交流群
QQ交流群：[1002350610 点击加入](https://jq.qq.com/?_wv=1027&k=45H977HM) ，欢迎你的加入
diff --git a/sa-token-doc/doc/index.css b/sa-token-doc/doc/index.css
index d27a1da5..0c3e09a1 100644
--- a/sa-token-doc/doc/index.css
+++ b/sa-token-doc/doc/index.css
@@ -10,3 +10,23 @@
.logo-box {display: none;}
.main-box .markdown-section{max-width: 1000px;}
}
+
+/* ============== 样式优化 ================ */
+
+/* 背景变黑 */
+.main-box [data-lang]{padding: 0px !important; border-radius: 10px; overflow: hidden;}
+.main-box [class^="lang-"]{/* color: red !important; */ border: 0px red solid; padding: 1.2em; background-color: #222; color: #FFF;}
+.main-box [class^="lang-api"]{color: #FFF;}
+
+
+.token.string{color: #65B042;}
+.token.number{color: #2487CC;}
+.token.punctuation{color: #FFF;}
+.token.comment{color: #FFF;}
+
+/* .main-box [class="lang-api"]{color: red;} */
+
+#main table{margin-left: 25px;}
+@media screen and (min-width: 800px) {
+ #main table tr th{min-width: 150px;}
+}
\ No newline at end of file