diff --git a/README.md b/README.md index e26215d..6412fda 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,75 @@ -# markdown uTools plugin +# Markdown uTools 插件 -主要用于在 uTools 中使用 markdown,支持在 uTools 中直接打开 markdown 文件,并且可以在 uTools 中直接编辑 markdown 文件,支持在 uTools 中直接预览 markdown 文件。 +一个专为 uTools 用户打造的高效 Markdown 编辑与管理工具。它集成了本地文件管理、实时预览编辑、全文搜索以及 Git 版本控制等功能,旨在提供流畅、沉浸式的写作体验。 -## 功能点 +## ✨ 核心特性 -1. 可以选着本地文件目录,然后打开文件目录在左侧,支持递归打开子目录,有按钮刷新左侧文件目录,并且可以切换已选着的本地文件目录。 -2. 可以在左侧文件目录中选择文件,然后在右侧打开文件,支持递归打开子目录中的文件 -3. 可以在右侧文件中直接编辑 markdown 文件,支持实时预览 -4. 功能点模仿Typora的功能点保持一致,比如: - 1. 可以在右侧文件中直接编辑 markdown 文件,支持实时预览 - 2. 可以切换源码模式 - 3. 可以直接粘贴图片,然后放到当前md文件中,图片会自动以这个md名称创建一个文件夹并放入,并且图片文件名会以当前时间戳命名,避免文件名冲突。 - 4. 可以导出当前md文件为html文件或pdf文件,可以加上水印,水印内容可以自定义。 -5. 搜索功能点: - 1. 可以在右侧文件中搜索内容,支持正则表达式搜索 - 2. 可以在搜索结果中直接跳转定位到搜索内容 - 3. 可以支持文件名搜索,也可以支持内容搜索,搜索出结果后,可以点击打开到指定的md文件,并且可以定位到指定的搜索内容,在右侧文件中直接显示搜索到的内容。 -6. 左侧目录功能点: - 1. 可以右键目录新增文件夹或文件 - 2. 可以右键文件删除文件 - 3. 可以右键文件夹删除文件夹 - 4. 可以右键重命名文件或文件夹 - 5. 可以复制当前md文件或目录的路径 - 6. 可以打开当前md文件或目录所在本地文件管理器 - 7. 可以复制克隆当前md文件或目录的路径,并在md文件和文件夹后面加一个 -copy 后缀,比如: - 1. 如果是文件,就复制克隆文件路径,并在文件后面加一个 -copy 后缀 - 2. 如果是文件夹,就复制克隆文件夹路径,并在文件夹后面加一个 -copy 后缀 -7. 其他功能点: - 1. 当选着的目录中有.git文件夹时,就可以在右侧顶部中添加按钮 提交git操作,比如:提交、推送、拉取等,当是提交时,弹窗提示输入提交信息。 +- **项目级管理**:支持打开本地目录作为项目根目录,提供完整的文件树视图。 +- **实时预览**:左侧编辑,右侧实时渲染,所见即所得。 +- **智能图片处理**:支持剪贴板图片直接粘贴,自动保存到本地资源目录。 +- **全文搜索**:支持文件名搜索及基于正则的全文内容搜索。 +- **Git 集成**:内置轻量级 Git 面板,支持查看状态、提交与推送。 +- **高度可定制**:多种主题色、暗黑模式以及自定义字体支持。 + +## 🚀 功能详情 + +### 1. 文件资源管理 +左侧侧边栏提供了完整的文件资源管理能力: +- **目录浏览**:递归展示文件目录结构,支持懒加载。 +- **历史记录**:自动记录最近打开的项目目录,支持快速切换。 +- **文件操作**: + - **新建**:支持创建文件 (`.md`) 和文件夹。 + - **重命名/删除**:右键菜单快捷操作。 + - **复制/克隆**:支持复制文件路径,或一键创建文件副本(自动添加 `-copy` 后缀)。 + - **系统打开**:支持在系统文件管理器中打开当前文件位置。 + +### 2. 沉浸式编辑体验 +- **多标签页**:支持同时打开多个文件进行编辑,标签页快速切换。 +- **快捷工具栏**:提供标题 (H1-H6)、加粗、斜体、删除线、引用、代码、链接、列表等常用格式快捷键。 +- **源码模式**:支持纯源码编辑模式,专注于内容本身。 +- **图片自动归档**:在编辑器中粘贴图片时,插件会自动将图片保存到 `./{filename}/` 目录下,并以时间戳命名,保持项目整洁。 + +### 3. 强大的搜索能力 +通过底部状态栏或快捷键唤起搜索面板: +- **文件名搜索**:快速查找项目内的文件(自动忽略 `.git` 和 `node_modules`)。 +- **内容搜索**:支持搜索 Markdown 文件内容,支持正则表达式,搜索结果可直接定位到具体行。 + +### 4. Git 版本控制 +当检测到项目根目录包含 `.git` 文件夹时,状态栏会显示 Git 入口: +- **状态查看**:实时查看工作区的文件变更状态。 +- **版本提交**:支持 `git add`、`git commit`、`git push` 和 `git pull` 等基础操作。 + +### 5. 个性化设置 +- **主题切换**:内置 8 种主题色(默认蓝、薄暮红、火山橙、极客蓝等)。 +- **暗黑模式**:完美适配夜间写作场景。 +- **字体定制**: + - **应用字体**:支持思源黑体、思源宋体、霞鹜文楷等多种开源字体。 + - **代码字体**:支持 Fira Code, JetBrains Mono, Source Code Pro 等程序员专用字体。 +- **侧边栏调节**:支持拖拽调整侧边栏宽度,适应不同屏幕尺寸。 + +## 🛠️ 构建与开发 + +本项目基于 Vue 3 + Vite 构建。 + +### 环境准备 +- Node.js (建议 v16+) +- npm 或 yarn + +### 安装依赖 +```bash +npm install +``` + +### 开发模式 +```bash +npm run dev +``` + +### 生产构建 +构建产物将输出到 `dist` 目录,可直接在 uTools 开发者工具中加载。 +```bash +npm run build +``` + +## 📝 配置说明 +插件会在项目根目录下生成 `.md-helper.json` 文件,用于存储该项目的特定配置(目前主要用于内部状态同步)。全局配置(如主题、历史记录)存储在 uTools 的用户数据目录中。 diff --git a/客户介绍文档.md b/客户介绍文档.md index e20fe58..1f2314e 100644 --- a/客户介绍文档.md +++ b/客户介绍文档.md @@ -1 +1,58 @@ -# markdown uTools 客户介绍文档 \ No newline at end of file +# Markdown uTools 客户介绍文档 + +## 📖 产品概述 +**Markdown uTools** 是一款深度集成在 uTools 平台上的生产力工具,专为需要高效处理文档、笔记和知识库的用户设计。它打破了传统 Markdown 编辑器与文件管理器分离的界限,在一个轻量级的界面中实现了从**管理**、**写作**、**搜索**到**版本控制**的全流程闭环。 + +无论您是程序员、技术写作者,还是知识管理爱好者,这款插件都能为您提供流畅、无干扰的写作体验。 + +--- + +## 🌟 核心价值 + +### 1. **一体化工作流 (All-in-One Workflow)** +不再需要在资源管理器、编辑器和 Git 终端之间频繁切换。打开 uTools,您就可以直接管理本地项目文件夹,完成从新建文档到推送代码的所有操作。 + +### 2. **极致的写作效率** +我们深知写作时的痛点。因此,我们提供了**自动图片管理**功能——截图后直接粘贴,图片自动保存到指定目录并生成链接,无需任何手动干预。配合实时预览和快捷键,让您的思绪不再被打断。 + +### 3. **开发者友好** +专为技术用户打造。内置 **Git 面板** 让版本控制触手可及;**正则搜索** 帮助您在海量文档中精准定位;**代码高亮** 与 **专业编程字体** 让代码片段赏心悦目。 + +--- + +## ✨ 功能亮点展示 + +### 📂 强大的文件资源管理 +- **项目级视图**:以目录树形式展示项目结构,清晰直观。 +- **智能历史**:自动记录您最近打开的 10 个项目路径,一键快速回溯。 +- **便捷操作**:支持文件/文件夹的创建、重命名、删除、复制以及克隆副本(自动添加 `-copy` 后缀)。 + +### 📝 沉浸式编辑与预览 +- **实时渲染**:左侧输入 Markdown 源码,右侧即时呈现渲染效果,所见即所得。 +- **多标签页**:支持同时打开多个文档,像浏览器一样便捷切换。 +- **工具栏辅助**:提供标题、加粗、列表、代码块等常用语法的快捷按钮。 +- **图片自动归档**:粘贴图片时,自动在当前文件同级创建资源文件夹,并以时间戳命名图片,保持项目整洁有序。 + +### 🔍 全局精准搜索 +- **文件名搜索**:毫秒级响应,快速查找项目文件。 +- **内容搜索**:深入文档内部,支持正则表达式匹配,精准定位到关键词所在的具体行数。 + +### 🛡️ 内置 Git 版本控制 +- **状态监控**:实时感知文件变更。 +- **可视化操作**:无需记忆命令行,通过图形界面即可完成 `Add`、`Commit`、`Push` 和 `Pull` 操作。 + +### 🎨 个性化定制体验 +- **多彩主题**:内置 8 种精心调配的主题色,随心切换。 +- **暗黑模式**:一键切换深色模式,呵护您的视力。 +- **字体工坊**: + - **界面字体**:集成霞鹜文楷、思源宋体等优质开源字体,提升阅读愉悦感。 + - **代码字体**:集成 Fira Code, JetBrains Mono 等顶级编程字体,让代码更美观。 + +--- + +## 🎯 适用场景 + +- **个人知识库管理**:构建基于本地文件的 Markdown 知识网络。 +- **技术文档编写**:编写包含大量代码和图片的技术博客或项目文档。 +- **日常笔记记录**:快速启动,记录灵感,即写即存。 +- **项目 README 维护**:直接打开项目根目录,快速修改并提交文档更新。