Skip to content

written by JavaScript. Convert HTML to Markdown.(将HTML转换为Markdown)

License

Notifications You must be signed in to change notification settings

siaikin/mdReverse

Folders and files

NameName
Last commit message
Last commit date

Latest commit

c1c720b · Jan 20, 2020

History

22 Commits
Jun 1, 2019
Jan 20, 2020
Jan 20, 2020
Oct 27, 2019
Jan 20, 2020
Oct 20, 2019
Oct 27, 2019
May 26, 2019
May 26, 2019
Jan 20, 2020
May 27, 2019
Aug 15, 2019
Oct 20, 2019
Oct 27, 2019
Oct 27, 2019
Oct 20, 2019
Oct 27, 2019
Aug 15, 2019

Repository files navigation

mdReverse

将HTML文本转换为Markdown格式文本。由JavaScript编写

Demo

安装

npm:

npm install md-reverse

script引入:

<script src="../dist/md-reverse.browser.js" type="application/javascript"></script>

前往Github下载

用法

ES6 Modules
import {MdReverse, TablePlugin, StrikethroughPlugin} from "md-reverse";

const mdReverse = new MdReverse();
mdReverse.toMarkdown(`<h1>Hello World!</h1>`);

// 使用插件扩展Table, Strikethrough语法
mdReverse.use(TablePlugin);
mdReverse.use(StrikethroughPlugin);
mdReverse.toMarkdown(`<h1><delHello World!</del></h1>`);
原生js
<script src="dist/md-reverse.browser.min.js"></script>
const mdReverse = new MdReverse();
mdReverse.toMarkdown(`<h1>Hello World!</h1>`);

// 使用插件扩展Table, Strikethrough语法
mdReverse.use(MdReverse.plugin['table']);
mdReverse.use(MdReverse.plugin['strikethrough']);
mdReverse.toMarkdown(`<h1><delHello World!</del></h1>`);

支持语法

  1. Markdown基本语法
  2. Table语法
  3. strikethrough语法

提示

  • 因为各个网站的网页结构千奇百怪,做不到匹配所有网站,建议转换的HTML文本本身就是由Markdown编写的或符合Markdown规范。 在转换非Markdown规范的HTML文本可能准确性会大大下降。
  • 目前仅能支持Markdown的基本语法扩展语法部分会在之后陆续完成。
  • 为了提高转换的准确性,对于无法识别的HTML标签,md-reverse会将其删除。这个问题在扩展语法部分完成后会尝试解决。