# html2md

**Repository Path**: alwarse/html2md

## Basic Information

- **Project Name**: html2md
- **Description**: node+ts ,html转测markdown工具
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-06
- **Last Updated**: 2025-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# HTML2Markdown 转换工具

## 项目简介

HTML2Markdown是一个高效的HTML转Markdown工具，能够将HTML文件或整个目录中的HTML文件批量转换为Markdown格式。支持常见的HTML元素转换，包括标题、段落、列表、链接和图片等。

## 技术栈

- Node.js
- TypeScript
- cheerio - 用于HTML解析
- 文件系统操作 (fs模块)

## 安装说明

1. 克隆项目到本地：
```bash
git clone [项目地址]
cd html2md
```

2. 安装依赖：
```bash
npm install
```

## 使用说明

### 命令行使用

```bash
node src/index.js <输入目录> <输出目录>
```

### 作为模块使用

```javascript
const HTML2Markdown = require('./src/index.js').default;

const converter = new HTML2Markdown({
    indentSize: 2,
    bulletPoint: '-'
});

// 转换单个文件
converter.convertFile('input.html', 'output.md');

// 转换整个目录
converter.convertDirectory('input_dir', 'output_dir');
```

## 项目结构

```
html2md/
├── src/              # 源代码目录
│   └── index.js      # 主程序文件
├── html/             # HTML源文件目录
├── output/           # 转换后的Markdown文件目录
├── package.json      # 项目配置文件
└── README.md         # 项目说明文档
```

## 主要功能

1. HTML到Markdown的转换
   - 支持标题转换 (h1-h6)
   - 支持段落转换
   - 支持有序和无序列表
   - 支持链接和图片

2. 批量转换
   - 支持整个目录的批量转换
   - 自动创建输出目录
   - 保持目录结构

3. 自定义选项
   - 可配置缩进大小
   - 可自定义列表符号

## 开发指南

### 代码风格

- 使用TypeScript进行开发
- 遵循ES6+语法规范
- 使用async/await处理异步操作

### 调试

可以使用以下命令进行调试：
```bash
node --inspect src/index.js <输入目录> <输出目录>
```

## 注意事项

1. 确保输入文件为有效的HTML格式
2. 转换大文件时注意内存使用
3. 建议定期备份重要文件

## 许可证

ISC License