jaywcjlove / html-to-markdown-cli

Command line tool that converts HTML to markdown.

@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

Command Help

Usage: html-to-markdown <URL|file path|-> [options] [--help|h] [--version|v]

Passing "-" as the first arg will take input from STDIN

Options:

  -v, --version, Show version number
  -h, --help, Displays help information.
  -o, --output <dir-path>, Output directory. defalut(dist)
  -s, --stdout, Output to stdout

Example:

  html-to-markdown ./html/index.html
  html-to-markdown https://jaywcjlove.github.io/idoc/
  html-to-markdown --output="dist"
  echo "<h1>hello world</h1>"| html-to-markdown - --stdout

Support Config

In the project's root directory, add a .htm2mdrc.js file with the following configuration to enable the rehype and remark plugins.

/**
 * @typedef {import("@wcj/html-to-markdown").Options} Options
 * @type {Options}
 **/
export default { 
  rehypeParseOption: {},
  rehypePlugins: [],
  remarkPlugins: [],
};

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 contributors.

License

Licensed under the MIT License.

html-to-markdown-cli's Issues

max call stack exceeded with 15mb html file

I was trying to serialize the colorado revised statute and found an edge case, just in case you want to optimize. for my purposes I dont need to fix this as there are html files split by section included as well.
https://leg.colorado.gov/agencies/office-legislative-legal-services/2023-crs-titles-download

crs2023-index.htm.tar.gz

Format not well when convert checked list

origin html:

<ul data-type="taskList">
    <li data-checked="false" data-type="taskItem">
        <label>
            <input type="checkbox">
            <span></span>
       </label>
       <div><p>question</p></div>
    </li>
</ul>

result:

Doesn't work from CLI

$ npx @wcj/html-to-markdown-cli ./changelog.html
sh: 1: html-to-markdown: not found

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/ci.yml

• actions/checkout v4
• actions/setup-node v4
• peaceiris/actions-gh-pages v4
• ncipollo/release-action v1

npm

example/demo1/package.json

• rehype-rewrite ^4.0.2

package.json

• idoc ^1.25.0
• lerna ^8.0.0
• tsbb ^4.2.3

packages/cli/package.json

• @types/minimist ~1.2.2
• auto-config-loader ^1.7.7
• fs-extra ^11.1.1
• minimist ~1.2.6
• node-fetch ^3.2.3
• node ^14.16 || >=16.0.0

packages/html-to-markdown/package.json

• rehype ^13.0.0
• rehype-format ^5.0.0
• rehype-ignore ^2.0.0
• rehype-remark ^10.0.0
• rehype-video ^2.0.0
• remark-gfm ^4.0.0
• remark-stringify ^11.0.0
• unified ^11.0.0
• node ^14.16 || >=16.0.0

---

• Check this box to trigger a request for Renovate to run again on this repository