74 lines
1.8 KiB
Markdown
74 lines
1.8 KiB
Markdown
# ReadMD - 网页转Markdown
|
||
|
||
一个Chrome浏览器扩展，用于将网页内容提取并导出为Markdown文件。
|
||
|
||
## 功能特性
|
||
|
||
- **自动提取**：使用Mozilla Readability算法自动识别页面主要内容
|
||
- **手动选择**：支持选中特定区域进行提取
|
||
- **图片处理**：保留图片URL链接（不转换为Base64）
|
||
- **多种导出**：支持复制到剪贴板或下载为.md文件
|
||
- **元数据**：自动提取标题、URL、描述等元信息
|
||
- **不修改原页**：提取过程不影响原始网页内容
|
||
|
||
## 技术栈
|
||
|
||
- React 18 + TypeScript
|
||
- Vite + @crxjs/vite-plugin
|
||
- Tailwind CSS
|
||
- @mozilla/readability（内容提取）
|
||
- Turndown（HTML转Markdown）
|
||
|
||
## 安装方法
|
||
|
||
1. 克隆项目
|
||
|
||
```bash
|
||
git clone <项目地址>
|
||
cd readmd
|
||
```
|
||
|
||
2. 安装依赖
|
||
|
||
```bash
|
||
npm install
|
||
```
|
||
|
||
3. 构建扩展
|
||
|
||
```bash
|
||
npm run build
|
||
```
|
||
|
||
4. 在Chrome中加载扩展
|
||
- 打开 `chrome://extensions/`
|
||
- 启用「开发者模式」
|
||
- 点击「加载已解压的扩展程序」
|
||
- 选择 `dist` 文件夹
|
||
|
||
## 使用方法
|
||
|
||
1. 点击浏览器工具栏中的扩展图标
|
||
2. 点击「提取文章」自动提取页面主要内容，或选中部分内容后点击「提取选中区域」
|
||
3. 在弹窗中预览提取结果
|
||
4. 点击「复制到剪贴板」或「下载.md文件」导出
|
||
|
||
## 项目结构
|
||
|
||
```text
|
||
readmd/
|
||
├── src/
|
||
│ ├── content/ # Content Script（注入到网页）
|
||
│ ├── popup/ # 弹出窗口
|
||
│ ├── background/ # Service Worker
|
||
│ ├── options/ # 设置页面
|
||
│ ├── utils/ # 工具函数
|
||
│ └── types/ # TypeScript类型定义
|
||
├── manifest.json # 扩展配置
|
||
└── vite.config.ts # Vite配置
|
||
```
|
||
|
||
## License
|
||
|
||
MIT
|