npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

html2md

v0.1.1

Published

An HTML to Markdown converter.

Downloads

23

Readme

HTML2MD: A JavaScript HTML-to-Markdown converter

HTML2MD attempts to convert HTML into Markdown by reducing an HTML document into simple, Markdown-compatible parts. This library is compatible with both browsers and Node.js.

HTML2MD does its best job to convert any HTML given to it and it is by no means perfect. Heavily formatted documents, for example, will likely fail to convert properly. A few assumptions are made about the HTML which outline it's limitations:

* Inline elements do not contain block elements.
* Standard HTML block elements are used to define and separate content.

Install

Download the latest version from our release page and use via a script tag. The variable html2md will be attached to window.

<script type="text/javascript" src="html2md.js"></script>

If using Browserify or Node.js, you can install via NPM and use via require("html2md").

$ npm install html2md

Basic Usage

Using HTML2MD is really easy; it's just a function!

var markdown = html2md("<h1>Hello World</h1>");
console.log(markdown); // -> # Hello World

Please see the documentation for specifics.

Building from Scratch

HTML2MD uses Grunt to build a Browserify bundle from the original source found in lib/. When the command below completes, the compiled source will be saved to dist/ directory.

npm install && grunt

If you don't the Grunt cli tools installed globally, run npm install -g grunt-cli before running that command.

Running the Unit Tests

HTML2MD has several unit tests written for Node.js and the browser. Before running tests, install all test dependencies:

npm install

To get tests running on Node.js, run:

npm test

To run tests in the browser, start a test server with this command. When the server is running, navigate your browser to http://localhost:8000.

npm run dev