# @maxtan/tohtml

> 将 docx 文件快速转换成可维护性高的HTML网页

Latest version **1.0.3** (published 2020-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install @maxtan/tohtml
pnpm add @maxtan/tohtml
yarn add @maxtan/tohtml
bun add @maxtan/tohtml
```

Provides the command `tohtml`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-08-31 |
| First published | 2019-12-26 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 32.9 KB |
| Known vulnerabilities | 0 (+7 in 1 direct dependencies) |
| Install scripts | no |
| Author | MaxTan |
| Maintainers | maxtan |
| Keywords | tohtml |

## Links

- npm: https://www.npmjs.com/package/@maxtan/tohtml
- Repository: https://github.com/MaxTan330/wonders/tree/master/packages/tohtml
- npm.io page: https://npm.io/package/@maxtan/tohtml

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^4.17.15
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.4.13
- [commander](https://npm.io/package/commander.md) ^4.0.1

## Alternatives

- [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads
- [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads
- [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads
- [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads
- [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-08-31
- 1.0.1 — 2020-04-07
- 0.0.1 — 2019-12-26

## README

# docx 转换 HTML

## 简介

将 docx 文件快速转换成可维护性高的HTML网页。主要应用场景：应用的隐私政策，用户协议等 docx 文件快速构建出网页，避免手动复制粘贴导致的文本错误问题。

**Node 环境需要 v10 及以上**

## 作为命令行工具安装

    npm install @maxtan/tohtml -g

### 在命令行中使用

    tohtml ./test.docx

### 命令行可配置参数

可以使用自定义模板语法，参考 lodash 模板语法

    tohtml ./test.docx -t test.template.html

## 作为包依赖安装

    npm install @maxtan/tohtml

### 作为包依赖使用

    const toHtml = require('@maxtan/tohtml');
    const path = require('path');
    //Basic use
    const testInit= async () => {
        const workOptions = {
            targetPath : path.resolve(__dirname,'./test.docx'), //源文件路径
            templatePath : path.resolve(__dirname,'./test.template.html'),  //模板文件路径
            isWirteFile : false //是否写入文件
        };
        const htmlStr = await toHtml.compiledToHtml(workOptions);
        console.log(htmlStr);
    };
    testInit();

### 配置项参数

| 参数名       | 描述         | 类型    | 备注                                                                                               |
| ------------ | ------------ | ------- | -------------------------------------------------------------------------------------------------- |
| targetPath   | 源文件路径   | string  | 传入绝对地址路径                                                                                   |
| templatePath | 模板文件路径 | string  | 使用 lodash 模板语法                                                                               |
| isWirteFile  | 是否写入文件 | boolean | 方法调用通常不写入文件，调用 `compiledToHtml` 方法时 默认 false 调用 `docxtohtml` 方法时 默认 true |

## 已知存在的问题

-   1.目前仅支持 docx 文件。
-   2.格式刷标识的序号可能会被忽略。请对生成的网页自行检查。

---
_Source: https://npm.io/package/@maxtan/tohtml · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._