Skip to content

docs: complete project README and documentation #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Hughhhhcoder wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

docs: complete project README and documentation #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ HTooL is a small, task-oriented toolkit for writing, development, and everyday d
| System & data | Data processor | Regex testing, URL encoding/decoding, Base64, MD5, and SHA-256 |
| System & data | IP lookup | IPv4 location, timezone, and network information |

## Tool routes

Each tool is available directly through a client-side route, which makes it easy to bookmark or deep-link a workflow:

| Route | Tool |
| --- | --- |
| `/markdown` | Markdown editor |
| `/markdown-html` | Markdown ↔ HTML converter |
| `/image-converter` | Image converter |
| `/qrcode` | QR code generator and decoder |
| `/drawing-board` | Drawing board |
| `/data-processor` | Regex, encoding, and hashing utilities |
| `/ip-location` | IP location lookup |

## Highlights

- Browser-first: image conversion, QR codes, drawing, and text processing run locally by default.
Expand Down Expand Up @@ -118,6 +132,8 @@ Copy `.env.example` to `.env` and adjust as needed:
- Vercel Analytics is disabled by default and is enabled only with `VITE_ENABLE_ANALYTICS=true`.
- Markdown and HTML previews are sanitized with DOMPurify. Review downloaded HTML before publishing it, especially when the source is untrusted.

The Markdown editor's local folder workflow uses the browser File System Access API and requires an explicit user permission. Support varies by browser; the rest of the toolbox remains useful without granting folder access.

## Project structure

```text
Expand Down
16 changes: 16 additions & 0 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,20 @@ HTooL 面向写作、开发和日常信息处理场景，优先把数据留在
| 系统与数据 | 数据处理工具 | 正则测试、URL 编码/解码、Base64、MD5 与 SHA-256 |
| 系统与数据 | IP 地址定位 | 查询 IPv4 的地域、时区与运营商信息 |

## 工具路由

每个工具都有独立的前端路由，可以直接收藏或分享某个具体工作流：

| 路由 | 工具 |
| --- | --- |
| `/markdown` | Markdown 编辑器 |
| `/markdown-html` | Markdown ↔ HTML 转换器 |
| `/image-converter` | 图片转换器 |
| `/qrcode` | 二维码生成与解析 |
| `/drawing-board` | 手绘板 |
| `/data-processor` | 正则、编码与哈希工具 |
| `/ip-location` | IP 地址定位 |

## 主要特点

- 浏览器优先：图片转换、二维码、绘图和文本处理默认在本地完成。
Expand Down Expand Up @@ -118,6 +132,8 @@ npm run check
- Vercel Analytics 默认关闭，只有显式设置 `VITE_ENABLE_ANALYTICS=true` 才会启用。
- Markdown 预览和 HTML 预览会经过 DOMPurify 清理；下载 HTML 前仍应审阅内容，尤其不要把不可信内容当作生产页面直接发布。

Markdown 编辑器的本地文件夹功能使用浏览器 File System Access API，需要用户显式授权。不同浏览器的支持程度不同；不授予文件夹权限也不影响其他工具使用。

## 项目结构

```text
Expand Down