Turndown 技术文档

本文档将为您详细介绍如何安装和使用 Turndown 项目，以及如何通过项目 API 进行操作。Turndown 是一个可以将 HTML 转换为 Markdown 的 JavaScript 库。

1. 安装指南

NPM 安装

使用 npm 进行安装：

npm install turndown

浏览器安装

在浏览器中使用 Turndown，可以通过以下方式引入：

<script src="https://unpkg.com/turndown/dist/turndown.js"></script>

对于 RequireJS 的使用，UMD 版本位于 lib/turndown.umd.js（用于 Node.js）和 lib/turndown.browser.umd.js（用于浏览器）。这些文件在 npm 包发布时生成。要手动生成它们，请克隆这个仓库并运行 npm run build。

2. 项目使用说明

Node.js 使用

在 Node.js 中使用 Turndown：

var TurndownService = require('turndown');

var turndownService = new TurndownService();
var markdown = turndownService.turndown('<h1>Hello world!</h1>');

Turndown 还接受 DOM 节点作为输入（元素节点、文档节点或文档片段节点）：

var markdown = turndownService.turndown(document.getElementById('content'));

选项

可以在实例化时向构造函数传入选项。例如：

var turndownService = new TurndownService({ option: 'value' });

以下是一些可用的选项：

选项	有效值	默认值
headingStyle	setext 或 atx	setext
hr	任何主题分隔符	* * *
bulletListMarker	-, +, 或 *	*
codeBlockStyle	indented 或 fenced	indented
fence	``` 或 ~~~	```
emDelimiter	_ 或 *	_
strongDelimiter	** 或 __	**
linkStyle	inlined 或 referenced	inlined
linkReferenceStyle	full, collapsed, 或 shortcut	full
preformattedCode	false 或 true	false

高级选项

选项	有效值	默认值
blankReplacement	规则替换函数	See Special Rules below
keepReplacement	规则替换函数	See Special Rules below
defaultReplacement	规则替换函数	See Special Rules below

3. 项目 API 使用文档

以下是 Turndown 的一些方法和使用示例：

addRule(key, rule)

添加一个新的规则：

turndownService.addRule('strikethrough', {
  filter: ['del', 's', 'strike'],
  replacement: function (content) {
    return '~' + content + '~'
  }
});

keep(filter)

确定哪些元素应该保留并渲染为 HTML：

turndownService.keep(['del', 'ins']);

remove(filter)

确定哪些元素应该完全移除：

turndownService.remove('del');

use(plugin|array)

使用插件或插件数组：

turndownService.use([tables, strikethrough]);

4. 项目安装方式

Turndown 支持两种主要的安装方式：npm 和浏览器直接引入。请参考上述“安装指南”部分获取详细步骤。

以上就是关于 Turndown 的技术文档，希望对您有所帮助。