@wcj/html-to-markdown
HTML conversion tool to markdown. command line tool => @wcj/html-to-markdown-cli.
Installation
This package is ESM only: Node 14+ is needed to use it and it must be import instead of require.
npm i @wcj/html-to-markdown
Command line tool
$ npx @wcj/html-to-markdown-cli ./html/index.html
# 🌐 Request: /Users/xxx/index.html
# 🎉 Compliled successfully!
# ╰┈ Output: /Users/xxx/dist/index.md
$ npx @wcj/html-to-markdown-cli https://jaywcjlove.github.io/idoc/
# 🌐 Request: https://jaywcjlove.github.io/idoc/
# 🎉 Compliled successfully!
# ╰┈ Output: /Users/xxx/dist/idoc.md
# Or
$ sudo npm i @wcj/html-to-markdown-cli -g
$ html-to-markdown ./html/index.html
# 🌐 Request: /Users/xxx/html/index.html
# 🎉 Compliled successfully!
# ╰┈ Output: /Users/xxx/html/dist/index.md
$ html-to-markdown https://jaywcjlove.github.io/idoc/
# 🌐 Request: https://jaywcjlove.github.io/idoc/
# 🎉 Compliled successfully!
# ╰┈ Output: /Users/xxx/dist/idoc.md
Usage
import htmlToMarkdown from '@wcj/html-to-markdown';
htmlToMarkdown({ html: '<h1>Markdown String</h1>' });
// => # Markdown String
API
import { PluggableList } from 'unified';
import { Options as RehypeParseOptions } from 'rehype-parse';
declare type Options = {
html?: string;
url?: string;
rehypeParseOption?: RehypeParseOptions;
/**
* List of [remark plugins](https://github.com/remarkjs/remark/blob/main/doc/plugins.md#list-of-plugins) to use.
* See the next section for examples on how to pass options
*/
remarkPlugins?: PluggableList;
/**
* List of [rehype plugins](https://github.com/rehypejs/rehype/blob/main/doc/plugins.md#list-of-plugins) to use.
* See the next section for examples on how to pass options
*/
rehypePlugins?: PluggableList;
};
export default function htmlToMarkdown(options?: Options): Promise<string>;
Development
$ npm i
$ npm install --workspaces
$ npm run build
$ npm run build:cli
Related
- markdown-to-html-cli Command line tool that converts markdown to HTML.
Contributors
As always, thanks to our amazing contributors!
Made with action-contributors.
License
Licensed under the MIT License.
60 Jan 1, 2023
14 Dec 31, 2022
9 Nov 20, 2022
45 Nov 4, 2022
0 Aug 4, 2022
16 Dec 26, 2022
7 Oct 4, 2022
7 May 5, 2023
43 Dec 20, 2022
9 Sep 3, 2022
91 Jan 2, 2023
25 Dec 20, 2022
7 Dec 13, 2022
13 Jan 2, 2023
53 Dec 17, 2022
8 Dec 27, 2022
8 Jun 12, 2022