chore: update documentation and add new guides for TINKER

Author: surunzi

.gitignore

@@ -1,4 +1,5 @@
 node_modules/
 docs/.vitepress/cache/
 dist/
+references/
 package-lock.json

.gitmodules

@@ -1,3 +1,9 @@
 [submodule "docs/.vitepress/share"]
 	path = docs/.vitepress/share
 	url = https://github.com/liriliri/docs-share.git
+[submodule "tinker"]
+	path = tinker
+	url = https://github.com/liriliri/tinker.git
+[submodule "tinker-plugins"]
+	path = tinker-plugins
+	url = https://github.com/liriliri/tinker-plugins.git

docs/.vitepress/config.mts

@@ -47,6 +47,18 @@ export default defineConfig({
       },
     },
     logo,
+    sidebar: {
+      'guide/': [
+        {
+          text: 'Introduction',
+          link: '/guide/',
+        },
+        {
+          text: 'Quick Start',
+          link: '/guide/quickstart',
+        },
+      ],
+    },
     socialLinks: [
       kofi,
       wechatpay,
@@ -64,11 +76,27 @@ export default defineConfig({
     root: {
       label: 'English',
       lang: 'en',
+      themeConfig: {
+        nav: [{ text: 'Guide', link: '/guide/' }],
+      },
     },
     zh: {
       label: '中文',
       lang: 'zh',
       themeConfig: {
+        nav: [{ text: '指南', link: '/zh/guide/' }],
+        sidebar: {
+          'zh/guide/': [
+            {
+              text: '前言',
+              link: '/zh/guide/',
+            },
+            {
+              text: '快速开始',
+              link: '/zh/guide/quickstart',
+            },
+          ],
+        },
         outlineTitle: '在这一页上',
         editLink: {
           pattern: editLinkPattern,

docs/guide/index.md

@@ -0,0 +1,24 @@
+# Introduction
+
+TINKER is a desktop toolbox application that brings together a variety of productivity tools. Whether you need quick calculations, image compression, or drawing diagrams, TINKER provides high-quality built-in plugins to handle common tasks efficiently.
+
+## Why TINKER?
+
+In daily work and life, we often need various small tools: a calculator, a color picker, an image compressor, and so on. Typically, these tools are scattered across different applications or websites, requiring frequent switching between them. TINKER solves this problem by integrating multiple productivity tools into a single, unified application.
+
+- **Quick Access**: Launch with a keyboard shortcut, search for the tool you need, and press Enter to open it. When you're done, TINKER automatically hides itself.
+- **High Quality**: Each built-in plugin is carefully crafted to ensure a smooth and reliable user experience.
+- **Extensible**: Beyond the built-in plugins, TINKER supports installing excellent third-party tools to expand its capabilities.
+
+## Supported Platforms
+
+TINKER supports the following platforms:
+
+- Windows x64
+- macOS Apple silicon
+- macOS Intel chip
+- Linux
+
+![screenshot](/screenshot.png)
+
+By reading the following guide, you will learn how to install, configure, and make the most of TINKER to boost your productivity.

docs/guide/quickstart.md

@@ -0,0 +1,38 @@
+# Quick Start
+
+## Installation
+
+TINKER supports [Windows x64](https://release.liriliri.io/tinker/TINKER-1.8.0-win-x64.exe), [macOS Apple silicon](https://release.liriliri.io/tinker/TINKER-1.8.0-mac-arm64.dmg), [macOS Intel chip](https://release.liriliri.io/tinker/TINKER-1.8.0-mac-x64.dmg) and [Linux](https://release.liriliri.io/tinker/TINKER-1.8.0-linux-x86_64.AppImage) platforms. After downloading and installing, simply click the desktop icon to start using it.
+
+## Basic Usage
+
+TINKER is designed to be as simple and efficient as possible:
+
+1. Use the keyboard shortcut to bring up TINKER.
+2. Type the name of the tool you need in the search bar.
+3. Press Enter to open the selected tool.
+4. After use, TINKER will automatically hide itself.
+
+:::info You can customize the keyboard shortcut in the settings.
+:::
+
+## User Interface
+
+TINKER's main interface consists of a search bar and a list of available tools. Simply start typing to filter tools, and press Enter to launch the one you need.
+
+Click the <Icon name="setting"/> icon to open settings, where you can configure the application's theme, language, keyboard shortcuts, and manage plugins.
+
+## Installing Plugins
+
+In addition to built-in tools, TINKER supports installing more plugins via npm:
+
+```bash
+npm i -g tinker-whois
+npm i -g tinker-drawio
+npm i -g tinker-deepseek
+```
+
+Once installed, plugins will automatically appear in the search interface.
+
+:::info Web-based plugins (e.g. tinker-deepseek) do not support offline use.
+:::

docs/zh/guide/index.md

@@ -0,0 +1,24 @@
+# 前言
+
+TINKER 是一个集合了多款效率小应用的桌面工具箱。无论是快速计算、图片压缩还是绘制图表，TINKER 都提供了高质量的内置插件来高效完成日常任务。
+
+## 为什么选择 TINKER？
+
+在日常工作和生活中，我们常常需要各种小工具：计算器、取色器、图片压缩器等等。通常这些工具分散在不同的应用或网站中，需要频繁切换。TINKER 将多种实用工具整合到一个统一的应用中，解决了这个问题。
+
+- **使用方便**：快捷键呼出，搜索工具回车打开，使用完自动隐藏。
+- **质量优秀**：每个内置插件都经过精心打造，确保流畅可靠的使用体验。
+- **丰富扩展**：除内置插件外，还支持安装第三方优秀工具来扩展功能。
+
+## 支持平台
+
+TINKER 支持以下平台：
+
+- Windows x64
+- macOS Apple silicon
+- macOS Intel chip
+- Linux
+
+![screenshot](/screenshot.png)
+
+通过阅读接下来的文档，你可以学习到如何安装、配置和充分利用 TINKER 来提升你的工作效率。

docs/zh/guide/quickstart.md

@@ -0,0 +1,36 @@
+# 快速开始
+
+## 安装
+
+TINKER 支持 [Windows x64](https://release.liriliri.io/tinker/TINKER-1.8.0-win-x64.exe)、[macOS Apple silicon](https://release.liriliri.io/tinker/TINKER-1.8.0-mac-arm64.dmg)、[macOS Intel chip](https://release.liriliri.io/tinker/TINKER-1.8.0-mac-x64.dmg) 和 [Linux](https://release.liriliri.io/tinker/TINKER-1.8.0-linux-x86_64.AppImage) 平台，下载安装后直接点击桌面图标开始使用。
+
+## 基本用法
+
+TINKER 的设计理念是尽可能简单高效：
+
+1. 使用快捷键呼出 TINKER。
+2. 在搜索栏中输入需要的工具名称。
+3. 按回车键打开选中的工具。
+4. 使用完毕后，TINKER 会自动隐藏。
+
+:::info 你可以在设置中自定义快捷键。
+:::
+
+## 用户界面
+
+TINKER 的主界面由搜索栏和可用工具列表组成。只需开始输入即可过滤工具，按回车键启动所需工具。
+
+## 安装插件
+
+除了内置工具外，TINKER 还支持通过 npm 安装更多插件：
+
+```bash
+npm i -g tinker-whois
+npm i -g tinker-drawio
+npm i -g tinker-deepseek
+```
+
+安装完成后，插件会自动出现在搜索界面中。
+
+:::info 网页类插件（如 tinker-deepseek）不支持离线使用。
+:::