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

markback

v0.0.1

Published

Converts html into sensible-looking markdown.

Downloads

4

Readme

markback

Sensible conversion from HTML to markdown. Will run in a browser, in a command line, or as a node module. It uses the DOM to do its magic: Whatever the browser sees should be what you get.

Still a work in progress -- some of the information in this document might not yet be true.

How to run:

In a browser:

<!doctype html>
<html>
  <head>
    <title>Convert to markdown!</title>
    <script src="https://raw.github.com/demands/markback/master/build/markback.min.js" type="text/javascript"></script>
  </head>
  <body>
    <div id="convertMe">
      <!-- html to convert goes here -->
    </div>
    <pre id="markdown">
      <script type="text/javascript">
        var markdown = Markback(document.getElementById("convertMe"));
        document.write(markdown);
      </script>
    </pre>
  </body>
</html>

From the command line:

$ npm install -g markback
$ markback < input.html > output.md

As a node module:

var Markback = require('markback')

// Can be done with regular callbacks:
Markback.convertHtml("<h1>Hello world</h1>", function(err, markdown) { console.log(markdown); });
// => # Hello world

// Can also be done with promises:
Markback.convertHtml("<h1>Hello world</h1>")
  .then(function(markdown) { console.log(markdown); });
// => # Hello world

Example output:

INPUT                                                           OUTPUT

<h1>This is a test</h1>                                         # This is a test

<p><b>Lorem ipsum</b> dolor sit amet, consectetur               **Lorem ipsum** dolor sit amet, consectetur
elit, sed do eiusmod tempor incididunt ut labore et             elit, sed do eiusmod tempor incididunt ut labore et
dolore magna aliqua. Ut enim ad minim veniam, qui               dolore magna aliqua. Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquip            nostrud exercitation ullamco laboris nisi ut aliquip
ex ea commodo consequat. Duis aute irure dolor in               ex ea commodo consequat. Duis aute irure dolor in
reprehenderit in voluptate velit esse cillum dolore             reprehenderit in voluptate velit esse cillum dolore
eu fugiat nulla pariatur. Excepteur sint occaecat               eu fugiat nulla pariatur. Excepteur sint occaecat
cupidatat non proident, sunt in culpa qui officia               cupidatat non proident, sunt in culpa qui officia
deserunt mollit anim id est laborum</p>                         deserunt mollit anim id est laborum

FAQ:

Q: Will it leave HTML it doesn't understand untouched?

A: It will try. No guarantees, though.

Q: Is it compatible with GitHub Flavored Markdown?

A: Not quite yet. The HTML for GitHub's flavor seems really complex. Maybe it would be a good v2.0 feature.

License:

MIT.