[feat] initialize

kinesin/index.md

@@ -0,0 +1,30 @@
+---
+outline: deep
+order: 1
+---
+
+# 何为 Kinesin？
+
+不知道您在上网的时候，会不会想用`blog.ke`这样独特的域名来访问网站，或者将深而不可测的长链接转化为短链接来使用，而Kinesin就是为了实现这些想法而诞生的。
+
+Kinesin 是一款轻量级的浏览器扩展，无需复杂的 Hosts 配置，即可轻松自定义 URL 重定向规则。它帮助您告别记忆长链接的烦恼，并根据您的需求实现各种个性化跳转。通过可选的服务器同步功能，您还可以在多个设备和浏览器之间享受一致的规则体验。
+
+## 产品亮点
+☁️ 简单高效：操作逻辑简单，具有干净，极简主义的界面
+
+🚀 跨平台：支持Google Chrome Edge Firefox等主流浏览器，您还可以将其适用于Pad等移动端
+
+📦 开源：代码开源，公开透明
+
+🧐 安全：我们不记录您的浏览历史，同步服务由你自部署，保证隐私安全
+
+## 立刻使用
+
+Kinesin已上架主流浏览器插件商店，您可一键安装使用。
+
+1. [Edge](https://microsoftedge.microsoft.com/addons/detail/kinesin/bfnnclfgealppofiiimocnpiombnoolg)
+2. [Firefox](https://addons.mozilla.org/zh-CN/firefox/addon/kinesin/)
+
+## 与我们一起
+
+个人的力量总是有限的，Kinesin 仍有许多可以改进之处。如果您有任何建议、想法或遇到了问题，欢迎在 [GitHub 仓库](https://github.com/gtxykn0504/kinesin-redirector) 中提出 Issue 或通过 Pull Request 贡献代码。

kinesin/online.md

@@ -0,0 +1,45 @@
+---
+outline: deep
+order: 3
+---
+
+# 同步功能
+
+通过服务器同步规则，您可以在多个设备和浏览器之间共享自定义的重定向规则，实现无缝的浏览体验。
+
+## 配置同步服务器
+
+Kinesin 的服务器端使用 PHP 编写，您可以按照以下步骤自行部署同步服务。
+
+### 1. 下载服务器端代码
+
+访问 [GitHub 仓库](https://github.com/gtxykn0504/kinesin-redirector/tree/main/server) 下载 `redirect.php` 文件。
+
+### 2. 编辑配置文件
+
+打开 `redirect.php`，根据您的实际情况修改以下两处配置：
+
+- **设置 API 密钥**：  
+  找到 `define('API_KEY', 'your-secret-key-here');`  
+  将 `your-secret-key-here` 替换为您自定义的密码，用于保证同步请求的安全性。
+
+- **指定规则存储文件**：  
+  找到 `$storageFile = __DIR__ . '/rules.json';`  
+  您可以修改 `rules.json` 的存储路径（例如 `/var/data/kinesin-rules.json`），请确保 PHP 进程对该文件及其所在目录拥有读写权限。
+
+### 3. 部署到服务器
+
+- 配置一个支持 PHP 的 Web 服务器（如 Apache、Nginx）。
+- 将编辑后的 `redirect.php` 上传到服务器上的合适目录。
+- 手动创建 `rules.json` 文件并设置正确的权限。
+
+### 4. 插件端配置
+
+1. 点击浏览器工具栏中的 Kinesin 图标。
+2. 在弹出窗口中，点击右上角的 ⚙️ 图标进入设置页面。
+3. 找到 同步设置 区域，输入您的 服务器 URL（例如 `https://example.com/redirect.php`）和 API 密钥。
+4. 启用“启用同步”开关，然后点击“保存”即可。
+
+## 自动下载规则
+
+如果您开启“启动时自动下载规则”选项，Kinesin 将在每次浏览器启动或点击插件图标时自动从服务器拉取最新的规则，您可以在插件弹窗或设置页面中查看当前的同步状态。

kinesin/use.md

@@ -0,0 +1,37 @@
+---
+outline: deep
+order: 2
+---
+
+# 使用指南
+
+## 添加跳转规则
+
+### 有效顶级域名
+
+如果您希望将 `blog.kgthe.top` 这样的有效顶级域名重定向到另一个地址，请按以下步骤操作：
+
+1. 点击浏览器工具栏中的 Kinesin 图标。
+2. 在弹出窗口中，将 `blog.kgthe.top` 填入 源 URL，将目标地址（如 `https://kegongteng.cn`）填入 目标 URL。
+3. 点击 添加 按钮。
+4. 在浏览器地址栏输入 `blog.kgthe.top` 并访问，即可验证跳转是否生效。
+
+### 自定义短域名
+
+如果您希望使用 `blog.ke`、`bing` 等非规范的短域名作为源地址，操作略有不同：
+
+1. 点击 Kinesin 图标，将 `bing` 填入 源 URL，目标地址填入 目标 URL。
+2. 点击 添加。
+3. 在浏览器地址栏输入 `bing/` 并访问，即可验证跳转是否生效。
+
+::: danger 重要提示
+对于非规范顶级域名，首次访问时**必须加上末尾的斜杠 `/`**，否则浏览器会将其作为搜索词处理。首次成功访问后，浏览器地址栏会自动补全斜杠，后续即可直接输入短域名。
+:::
+
+## 分组管理规则
+
+随着规则数量增多，分组功能可以帮助您更好地组织和管理。
+
+在使用该功能之前，请您事先添加组。首先，点击浏览器的Kinesin插件。在弹出的页面中，点击右上角的 ⚙️ 图标，进入设置页面。在规则列表中，您可以点击分组标题旁的 ➕ 图标，新增分组。
+
+您可以手动设定分组，或者通过自动分组功能。自动分组依据源URL 目标URL是否包含某种特定字符来分类，它可在添加分组时或者点击已有组标题旁的 ✏️ 图标进入编辑分组选项来设定。在添加规则时，将 分组 选项调至 自动分组 即可按设定的规则分类。