# html-md > JavaScript library for converting HTML in to valid Markdown Latest version **3.0.2** (published 2013-10-09) · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install html-md pnpm add html-md yarn add html-md bun add html-md ``` Provides the command `htmlmd`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 3.0.2 | | Published | 2013-10-09 | | First published | 2012-12-11 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 159 | | Author | Alasdair Mercer | | Maintainers | neocotic | | Keywords | html, markdown, convert | ## Links - npm: https://www.npmjs.com/package/html-md - Repository: https://github.com/neocotic/html.md - Homepage: http://neocotic.com/html.md - Issues: https://github.com/neocotic/html.md/issues - npm.io page: https://npm.io/package/html-md ## Dependencies (3) - [jsdom](https://npm.io/package/jsdom.md) ~0.8.6 - [fs-extra](https://npm.io/package/fs-extra.md) ~0.7.0 - [commander](https://npm.io/package/commander.md) ~2.0.0 ## Alternatives - [@tsparticles/shape-image](https://npm.io/package/@tsparticles/shape-image.md) — 303.7K weekly downloads - [@tsparticles/shape-line](https://npm.io/package/@tsparticles/shape-line.md) — 233.7K weekly downloads - [stringify-attributes](https://npm.io/package/stringify-attributes.md) — 58.6K weekly downloads - [mobile-drag-drop](https://npm.io/package/mobile-drag-drop.md) — 46.3K weekly downloads - [@comunica/actor-rdf-parse-html](https://npm.io/package/@comunica/actor-rdf-parse-html.md) — 29.2K weekly downloads ## Recent versions - 3.0.2 (latest) — 2013-10-09 - 3.0.2-beta — 2013-10-09 - 3.0.2-alpha — 2013-10-09 - 3.0.1 — 2013-08-16 - 3.0.0 — 2013-08-15 - 2.1.1 — 2013-05-06 - 2.1.0 — 2013-05-03 - 2.0.2 — 2013-02-04 - 2.0.1 — 2012-12-12 - 2.0.0 — 2012-12-11 ## README __ __ ___ __ /\ \ /\ \__ /\_ \ /\ \ \ \ \___\ \ ,_\ ___ ___\//\ \ ___ ___ \_\ \ \ \ _ `\ \ \/ /' __` __`\\ \ \ /' __` __`\ /'_` \ \ \ \ \ \ \ \_/\ \/\ \/\ \\_\ \_ __/\ \/\ \/\ \/\ \L\ \ \ \_\ \_\ \__\ \_\ \_\ \_\\____\\_\ \_\ \_\ \_\ \___,_\ \/_/\/_/\/__/\/_/\/_/\/_//____//_/\/_/\/_/\/_/\/__,_ / [html.md][] is a pure JavaScript library for converting [HTML][] in to valid [Markdown][]. [![Build Status](https://secure.travis-ci.org/neocotic/html.md.png)](http://travis-ci.org/neocotic/html.md) [html.md][] can be used normally in any browser as well as in the [node.js][] environment where it also provides a command line interface. * [Install](#install) * [Examples](#examples) * [Usage](#usage) * [API](#api) * [md](#mdhtml-options) * [Miscellaneous](#miscellaneous) * [Windows](#windows) * [Bugs](#bugs) * [Questions](#questions) ## Install Install using the package manager for your desired environment(s): ``` bash # for node.js: $ npm install html-md # OR; for the browser: $ bower install html-md ``` ## Examples In the browser: ``` html

Hello, World!

My tasks for today:

``` In [node.js][]: ``` javascript var md = require('html-md'); console.log(md('I love html.md!')); ``` The fantastic [jsdom][] library is used in this environment in order to simulate a working DOM to be traversed and translated to Markdown (see the [Windows](#windows) section for important notes about support for this platform). In the terminal: ``` bash # provide HTML to be converted and print it back out to stdout: $ htmlmd -epi "I love html.md" I **love** [html.md](http://neocotic.com/html.md) # convert HTML files and output them into another directory: $ htmlmd -o ./markdown ./html/*.html # convert all HTML files in the current directory into Markdown files: $ htmlmd -l . ``` ## Usage Usage: htmlmd [options] [ -e html | ] Options: -h, --help output usage information -V, --version output the version number -a, --absolute always use absolute URLs for links and images -b, --base set base URL to resolve relative URLs from -d, --debug print additional debug information -e, --eval pass a string from the command line as input -i, --inline generate inline style links -l, --long-ext use long extension for Markdown files -o, --output set the output directory for converted Markdown -p, --print print out the converted Markdown ## API ### md(html, [options]) Parses the HTML into a valid [Markdown][] string. The `html` can either be an HTML string or DOM element. ``` javascript console.log(md('I love html.md!')); // "I **love** html.md!" console.log(md(document.querySelector('p'))); // "Lorem ipsum, *baby*!" ``` #### Options The following options are recognised by this method (all of which are optional);
Property Description
absolute All links and images are parsed with absolute URLs
base All relative links and images are resolved from this URL
debug Prepends additional debug information to the Markdown output
inline All links are generated using the inline style
**Note:** The `base` option *only* works in the [node.js][] environment. ### Miscellaneous #### `noConflict()` Returns `md` in a no-conflict state, reallocating the `md` global variable name to its previous owner, where possible. This is really just intended for use within a browser. ``` html ``` #### `version` The current version of `md`. ``` javascript console.log(md.version); // "3.0.2" ``` ## Windows *This section is only relevant for [node.js][] users and does not affect browsers.* A lot of care has been put in to ensure [html.md][] runs well on Windows. Unfortunately, one of the dependencies of the [jsdom][] library, which we depend on to emulate a DOM within the [node.js][] environment, does not build well on Windows systems since it's built using "native modules" that are compiled during installation. [Contextify][], the inherited dependency in question, is used to run `