https://github.com/siaikin/mdreverse
written by JavaScript. Convert HTML to Markdown.（将HTML转换为Markdown）
https://github.com/siaikin/mdreverse
html html-to-markdown htmltomarkdown javascript
Last synced: over 1 year ago
JSON representation
written by JavaScript. Convert HTML to Markdown.（将HTML转换为Markdown）
- Host: GitHub
- URL: https://github.com/siaikin/mdreverse
- Owner: siaikin
- License: mit
- Created: 2019-05-26T09:02:39.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-20T16:41:49.000Z (over 6 years ago)
- Last Synced: 2025-04-12T04:52:22.954Z (over 1 year ago)
- Topics: html, html-to-markdown, htmltomarkdown, javascript
- Language: JavaScript
- Homepage: https://siaikin.github.io/mdReverse/
- Size: 317 KB
- Stars: 16
- Watchers: 0
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mdReverse
将HTML文本转换为Markdown格式文本。由JavaScript编写
[Demo](https://siaikin.github.io/mdReverse/)
* [开发进度](docs/development.md)
* [English Version](./docs/README_EN.md)
## 安装
npm:
```
npm install md-reverse
```
script引入:
```html
```
前往[Github](https://github.com/siaikin/mdReverse/releases/tag/v1.0.0)下载
## 用法
* [插件开发说明](./docs/pluginDevelopment.md)
###### ES6 Modules
```javascript
import {MdReverse, TablePlugin, StrikethroughPlugin} from "md-reverse";
const mdReverse = new MdReverse();
mdReverse.toMarkdown(`
Hello World!
`);
// 使用插件扩展Table, Strikethrough语法
mdReverse.use(TablePlugin);
mdReverse.use(StrikethroughPlugin);
mdReverse.toMarkdown(`
`);
```
###### 原生js
```html
```
```javascript
const mdReverse = new MdReverse();
mdReverse.toMarkdown(`
Hello World!
`);
// 使用插件扩展Table, Strikethrough语法
mdReverse.use(MdReverse.plugin['table']);
mdReverse.use(MdReverse.plugin['strikethrough']);
mdReverse.toMarkdown(`
`);
```
## 支持语法
1. [Markdown基本语法](https://www.markdownguide.org/basic-syntax/)
2. [Table语法](https://www.markdownguide.org/extended-syntax/#tables)
3. [strikethrough语法](https://www.markdownguide.org/extended-syntax/#strikethrough)
## 提示
* 因为各个网站的网页结构千奇百怪，做不到匹配所有网站，建议转换的HTML文本本身就是由Markdown编写的或符合Markdown规范。
在转换非Markdown规范的HTML文本可能准确性会大大下降。
* 目前仅能支持Markdown的[基本语法](https://www.markdownguide.org/basic-syntax)。[扩展语法](https://www.markdownguide.org/extended-syntax)部分会在之后陆续完成。
* 为了提高转换的准确性，对于无法识别的HTML标签，`md-reverse`会将其删除。这个问题在扩展语法部分完成后会尝试解决。