utools 插件
Go to file
cfq b058b0b50a docs: 更新产品介绍文档和README以完善功能描述
- 重写客户介绍文档,采用更专业的营销文案风格,突出核心价值与功能亮点
- 重构README文档结构,将功能点列表转换为分类清晰的功能模块描述
- 统一两个文档的产品名称和术语表述,提升整体一致性
- 在README中添加构建与开发说明,为开发者提供更完整的技术信息
2026-01-27 16:54:02 +08:00
.trae feat: 新增预览编辑模式并优化文件图标与字体 2026-01-26 17:08:13 +08:00
public chore: 更新插件配置并重置版本为1.0.0 2026-01-27 16:36:37 +08:00
scripts 初始化项目 2026-01-26 11:44:31 +08:00
src style(FileTree): 继承字体族以保持视觉一致性 2026-01-27 16:01:20 +08:00
.gitignore 初始化项目 2026-01-26 11:44:31 +08:00
CHANGELOG.md chore: 更新插件配置并重置版本为1.0.0 2026-01-27 16:36:37 +08:00
README.md docs: 更新产品介绍文档和README以完善功能描述 2026-01-27 16:54:02 +08:00
index.html feat(theme): 扩展字体选项并支持主题配置持久化 2026-01-27 15:59:55 +08:00
jsconfig.json 初始化项目 2026-01-26 11:44:31 +08:00
package-lock.json feat(editor): 为代码块添加语法高亮支持 2026-01-27 14:59:14 +08:00
package.json chore: 更新插件配置并重置版本为1.0.0 2026-01-27 16:36:37 +08:00
tsconfig.json 初始化项目 2026-01-26 11:44:31 +08:00
vite.config.js 初始化项目 2026-01-26 11:44:31 +08:00
客户介绍文档.md docs: 更新产品介绍文档和README以完善功能描述 2026-01-27 16:54:02 +08:00

README.md

Markdown uTools 插件

一个专为 uTools 用户打造的高效 Markdown 编辑与管理工具。它集成了本地文件管理、实时预览编辑、全文搜索以及 Git 版本控制等功能,旨在提供流畅、沉浸式的写作体验。

核心特性

  • 项目级管理:支持打开本地目录作为项目根目录,提供完整的文件树视图。
  • 实时预览:左侧编辑,右侧实时渲染,所见即所得。
  • 智能图片处理:支持剪贴板图片直接粘贴,自动保存到本地资源目录。
  • 全文搜索:支持文件名搜索及基于正则的全文内容搜索。
  • Git 集成:内置轻量级 Git 面板,支持查看状态、提交与推送。
  • 高度可定制:多种主题色、暗黑模式以及自定义字体支持。

🚀 功能详情

1. 文件资源管理

左侧侧边栏提供了完整的文件资源管理能力:

  • 目录浏览:递归展示文件目录结构,支持懒加载。
  • 历史记录:自动记录最近打开的项目目录,支持快速切换。
  • 文件操作
    • 新建:支持创建文件 (.md) 和文件夹。
    • 重命名/删除:右键菜单快捷操作。
    • 复制/克隆:支持复制文件路径,或一键创建文件副本(自动添加 -copy 后缀)。
    • 系统打开:支持在系统文件管理器中打开当前文件位置。

2. 沉浸式编辑体验

  • 多标签页:支持同时打开多个文件进行编辑,标签页快速切换。
  • 快捷工具栏:提供标题 (H1-H6)、加粗、斜体、删除线、引用、代码、链接、列表等常用格式快捷键。
  • 源码模式:支持纯源码编辑模式,专注于内容本身。
  • 图片自动归档:在编辑器中粘贴图片时,插件会自动将图片保存到 ./{filename}/ 目录下,并以时间戳命名,保持项目整洁。

3. 强大的搜索能力

通过底部状态栏或快捷键唤起搜索面板:

  • 文件名搜索:快速查找项目内的文件(自动忽略 .gitnode_modules)。
  • 内容搜索:支持搜索 Markdown 文件内容,支持正则表达式,搜索结果可直接定位到具体行。

4. Git 版本控制

当检测到项目根目录包含 .git 文件夹时,状态栏会显示 Git 入口:

  • 状态查看:实时查看工作区的文件变更状态。
  • 版本提交:支持 git addgit commitgit pushgit pull 等基础操作。

5. 个性化设置

  • 主题切换:内置 8 种主题色(默认蓝、薄暮红、火山橙、极客蓝等)。
  • 暗黑模式:完美适配夜间写作场景。
  • 字体定制
    • 应用字体:支持思源黑体、思源宋体、霞鹜文楷等多种开源字体。
    • 代码字体:支持 Fira Code, JetBrains Mono, Source Code Pro 等程序员专用字体。
  • 侧边栏调节:支持拖拽调整侧边栏宽度,适应不同屏幕尺寸。

🛠️ 构建与开发

本项目基于 Vue 3 + Vite 构建。

环境准备

  • Node.js (建议 v16+)
  • npm 或 yarn

安装依赖

npm install

开发模式

npm run dev

生产构建

构建产物将输出到 dist 目录,可直接在 uTools 开发者工具中加载。

npm run build

📝 配置说明

插件会在项目根目录下生成 .md-helper.json 文件,用于存储该项目的特定配置(目前主要用于内部状态同步)。全局配置(如主题、历史记录)存储在 uTools 的用户数据目录中。