`@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

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.

Dependency Dashboard

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

Other Branches

These updates are pending. To force PRs open, click the checkbox below.

chore(deps): update actions/checkout action to v4
chore(deps): update actions/setup-node action to v4

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update dependency lerna to v8

Detected dependencies

github-actions

.github/workflows/ci.yml

actions/checkout v3

actions/setup-node v3

peaceiris/actions-gh-pages v3

ncipollo/release-action v1

npm

package.json

idoc ^1.25.0

lerna ^7.3.0

tsbb ^4.2.3

packages/cli/package.json

@types/minimist ~1.2.2

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

jaywcjlove / html-to-markdown-cli Goto Github PK

html-to-markdown-cli's Introduction

@wcj/html-to-markdown

Installation

Usage

API

Development

Related

Contributors

License

html-to-markdown-cli's People

Contributors

Stargazers

Watchers

Forkers

html-to-markdown-cli's Issues

Other Branches

Open

Detected dependencies

Recommend Projects

Recommend Topics

Recommend Org

`@wcj/html-to-markdown`