# Format Fusion

**Repository Path**: Ling_wei_qiang/format-fusion

## Basic Information

- **Project Name**: Format Fusion
- **Description**: 格式融合库（Format Fusion）是一个用于在 Markdown、HTML5 和纯文本之间进行格式转换的三方库。它提供了简单易用的
API，帮助开发者轻松实现文本格式的互转。该库特别适用于需要在不同文本格式之间进行转换的项目，如内容管理系统、编辑器插件等。
- **Primary Language**: TypeScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-01-19
- **Last Updated**: 2025-01-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# 格式融合库（Format Fusion）使用指南

格式融合库（Format Fusion）是一个用于在 Markdown、HTML5 和纯文本之间进行格式转换的三方库。它提供了简单易用的
API，帮助开发者轻松实现文本格式的互转。该库特别适用于需要在不同文本格式之间进行转换的项目，如内容管理系统、编辑器插件等。

## 目录
- [格式融合库（Format Fusion）使用指南](#格式融合库format-fusion使用指南)
    - [安装](#安装)
    - [导出能力](#导出能力)
        - [使用示例](#使用示例)
            - [1. 判断文本格式](#1-判断文本格式)
            - [2. 格式转换](#2-格式转换)
        - [注意事项](#注意事项)
    - [联系我们](#联系我们)
        - [官网](#官网)
        - [关于坚果派](#关于坚果派)
        - [出版书籍](#出版书籍)
        - [三方库列表](#三方库列表)
        - [联系方式](#联系方式)
        - [加入微信群](#加入微信群)
        - [说明](#说明)


## 安装

通过以下命令安装格式融合库：

```
ohpm install formatfusion
```

## 导出能力

方法介绍detectTextFormat判断文本的格式类型，返回 'html'、'markdown' 或 'txt（纯文本）'。FusionType枚举类型，用于表示支持的文本格式类型，包括
H5、MD 和 TXT。formatInterop格式互操作函数，用于在不同文本格式之间进行转换。根据指定的 FusionType 枚举值，将输入的文本内容转换为目标格式。

### 使用示例

1. 判断文本格式

```
import { detectTextFormat } from '@ohos/formatfusion';

const content = `# Heading 1\nThis is a **bold** text.`;
const formatType = detectTextFormat(content);
console.log(formatType); // 输出：'markdown'
```

2. 格式转换

```
import { formatInterop, FusionType } from '@ohos/formatfusion';

const markdownContent = `# Heading 1\nThis is a **bold** text.`;
const htmlContent = formatInterop(markdownContent, FusionType.H5);
console.log(htmlContent); // 输出转换后的 HTML5 内容
```

### 注意事项

目前纯文本转 H5 和 MD 的规则尚未确定，相关功能暂不支持。
在使用 formatInterop 方法时，确保传入的 FusionType 枚举值正确，以避免转换错误。

## 联系我们

### 官网

[点击打开【官网-坚果派】](https://www.nutpi.net/)

### 关于坚果派

最初我们以鸿蒙为基石，不断向同级诸如 ArkUI-X、仓颉，以及同类诸如蓝河、欧拉等扩展，如今在不断努力和尝试下，我们平台已具备了各类产品的优秀开发团队及支持运营的万粉团队。专注于分享的技术包括
HarmonyOS/OpenHarmony、仓颉、ArkUI-X、AI、BlueOS 操作系统。团队成员主要聚集在北京，上海，南京，深圳，广州，苏州、长沙、宁夏等地，目前已为华为、vivo、腾讯、亚马逊以及三方技术社区提供各类咨询
200+。累计粉丝 100+w，孵化开发者 10w+，高校 20+、企业 10+。自研应用 14 款，三方库 70 个，鸿蒙原生应用课程 500+。持续助力鸿蒙仓颉等生态繁荣发展。

### 出版书籍

[《极速探索HarmonyOS NEXT：纯血鸿蒙应用开发实践》](https://item.jd.com/10134604131101.html?sdx=ehi-lLxFuZiE6JnJYodajMIhszGQCAorsmpIsapEaN-NPe_RLJ5a5H3joUzhUGWV)

购买链接：https://item.jd.com/10134604131101.html?sdx=ehi-lLxFuZiE6JnJYodajMIhszGQCAorsmpIsapEaN-NPe_RLJ5a5H3joUzhUGWV

### 三方库列表

[坚果派三方库汇总](https://docs.qq.com/sheet/DYnl1dUxhV21JTWNl?tab=BB08J2)


### 联系方式
- **微信号**：Dev-Mr-Lin
- **联系人**：Mr. Lin

### 加入微信群

为了更好地集中讨论和交流，我们特此设立了一个微信群。请添加上述微信号，并注明“Format Fusion三方仓交流”，以便我们邀请你加入群聊。此群仅限于讨论与三方库相关的内容，确保交流的专注性和高效性。

我们期待你的加入，共同探讨和分享技术的乐趣！


### 说明

- **注意事项**：特别注明了纯文本转 H5 和 MD 的规则尚未确定，相关功能暂不支持。