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

json2md

v2.0.1

Published

A JSON to Markdown converter.

Downloads

336,054

Readme

json2md

json2md

Support me on Patreon Buy me a book PayPal Ask me anything Version Downloads Get help on Codementor

A JSON to Markdown converter.

If you're looking to use this on the client side, that's also possible. Check out the dist directory.

:cloud: Installation

# Using npm
npm install --save json2md

# Using yarn
yarn add json2md

:clipboard: Example

const json2md = require("json2md")

console.log(json2md([
    { h1: "JSON To Markdown" }
  , { blockquote: "A JSON to Markdown converter." }
  , { img: [
        { title: "Some image", source: "https://example.com/some-image.png" }
      , { title: "Another image", source: "https://example.com/some-image1.png" }
      , { title: "Yet another image", source: "https://example.com/some-image2.png" }
      ]
    }
  , { h2: "Features" }
  , { ul: [
        "Easy to use"
      , "You can programmatically generate Markdown content"
      , "..."
      ]
    }
  , { h2: "How to contribute" }
  , { ol: [
        "Fork the project"
      , "Create your branch"
      , "Raise a pull request"
      ]
    }
  , { h2: "Code blocks" }
  , { p: "Below you can see a code block example." }
  , { "code": {
        language: "js"
      , content: [
          "function sum (a, b) {"
        , "   return a + b"
        , "}"
        , "sum(1, 2)"
        ]
      }
    }
]))
// =>
// # JSON To Markdown
// > A JSON to Markdown converter.
//
// ![Some image](https://example.com/some-image.png)
//
// ![Another image](https://example.com/some-image1.png)
//
// ![Yet another image](https://example.com/some-image2.png)
//
// ## Features
//
//  - Easy to use
//  - You can programmatically generate Markdown content
//  - ...
//
// ## How to contribute
//
//  1. Fork the project
//  2. Create your branch
//  3. Raise a pull request
//
// ## Code blocks
//
// Below you can see a code block example.
//
// ```js
// function sum (a, b) {
//    return a + b
// }
// sum(1, 2)
// ```

:question: Get Help

There are few ways to get help:

  1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. :bug:
  3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

json2md(data, prefix)

Converts a JSON input to markdown.

Supported elements

| Type | Element | Data | Example | |--------------|--------------------|--------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------| | h1 | Heading 1 | The heading text as string. | { h1: "heading 1" } | | h2 | Heading 2 | The heading text as string. | { h2: "heading 2" } | | h3 | Heading 3 | The heading text as string. | { h3: "heading 3" } | | h4 | Heading 4 | The heading text as string. | { h4: "heading 4" } | | h5 | Heading 5 | The heading text as string. | { h5: "heading 5" } | | h6 | Heading 6 | The heading text as string. | { h6: "heading 6" } | | p | Paragraphs | The paragraph text as string or array (multiple paragraphs). | { p: "Hello World"} or multiple paragraphs: { p: ["Hello", "World"] } | | blockquote | Blockquote | The blockquote as string or array (multiple blockquotes) | { blockquote: "Hello World"} or multiple blockquotes: { blockquote: ["Hello", "World"] } | | img | Image | An object or an array of objects containing the title, source and alt fields. | { img: { title: "My image title", source: "http://example.com/image.png", alt: "My image alt" } } | | ul | Unordered list | An array of strings or lists representing the items. | { ul: ["item 1", "item 2"] } | | ol | Ordered list | An array of strings or lists representing the items. | { ol: ["item 1", "item 2"] } | | hr | Separator | None | { hr: "" } | | code | Code block element | An object containing the language (String) and content (Array or String) fields. | { code: { "language": "html", "content": "<script src='dummy.js'></script>" } } | | table | Table | An object containing the headers (Array of Strings) and rows (Array of Arrays or Objects). | { table: { headers: ["a", "b"], rows: [{ a: "col1", b: "col2" }] } } or { table: { headers: ["a", "b"], rows: [["col1", "col2"]] } } | | link | Link | An object containing the title and the source fields. | { title: 'hello', source: 'https://ionicabizau.net' } |

You can extend the json2md.converters object to support your custom types.

json2md.converters.sayHello = function (input, json2md) {
   return "Hello " + input + "!"
}

Then you can use it:

json2md({ sayHello: "World" })
// => "Hello World!"

Params

  • Array|Object|String data: The input JSON data.
  • String prefix: A snippet to add before each line.

Return

  • String The generated markdown result.

async

Params

  • Array|Object|String data: The input JSON data.
  • String prefix: A snippet to add before each line.

Return

  • Promise.<String, Error> The generated markdown result.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

  • Starring and sharing the projects you like :rocket:

  • Buy me a book—I love books! I will remember you after years if you buy me one. :grin: :book:

  • PayPal—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

  • Support me on Patreon—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

  • Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

  • @lm_fe/scripts
  • @eventcatalog/utils
  • @servable/manifest
  • @best/github-integration
  • @microfleet/schema2md
  • @cypress/schema-tools
  • @asyncapi/diff
  • @sidneys/releasenotes
  • merak-compile
  • @best/store
  • jumia-travel-changelog
  • npm-ex-xpi
  • doc-vue3
  • @feizheng/react-markdown-props
  • heat-sfdx-tooling
  • @cobalt-engine/change-logger
  • lambda-docs-2md
  • servable-manifest
  • @gracexwho/model-card-generator
  • rap2doc
  • @dschau/gatsby-source-google-docs
  • rush-archive-project-plugin
  • sfhdown
  • tcdown
  • bookmark2md
  • cwq
  • @bonitasoft/dependency-list-to-markdown
  • github-repo-tools
  • gridsome-source-google-docs
  • notion2mdblog
  • kindle-highlights
  • make-postgres-markdown
  • @dlsl/hardhat-markup
  • @aligov/module-doc
  • @opas/plugin-doc
  • @xygengcn/koa-api-docs
  • @dididc/dc-extension
  • parse-google-docs-json
  • cli-demo3
  • gatsby-source-gdocs2md
  • kbase-components
  • lbdoc-p
  • chdown-workers
  • @bwagener/gridsome-source-google-docs
  • doc-cli
  • galaxy-vuepress-docs
  • dargstack_rgen
  • react-docgen-markdown
  • @e2y/bdd-dictionary-generator
  • @medyll/css-fabric-helper
  • @oasis-engine/oasis-run
  • @flive/react-kit
  • @shelex/schema-tools
  • @apica-io/asm-auto-deploy
  • @haimmag/schema-tools
  • rober19-config
  • @klarna/postgres-to-docs
  • @wii/swagger-plugin-transform-doc
  • cloudcastsdown
  • eddown
  • msdown
  • laradown
  • my_ccdown
  • mokker
  • gatsby-source-google-docs
  • gatsby-source-google-docs-sheets
  • platzi-virtual-machine
  • chdown
  • @yesand/asterism
  • ccdown
  • doc-vue
  • @hitorisensei/monorepo-readme-generator
  • uxcore-tools
  • @gigsboat/cli
  • joi-md-doc
  • @everything-registry/sub-chunk-1986
  • describe-dependencies
  • lab-changelog
  • node-red-contrib-json2md
  • p2doc
  • @eventcatalogtest/plugin-doc-generator-asyncapi
  • @solarity/hardhat-markup
  • @s-ui/changelog
  • component-docs-2md
  • codexer
  • @balmacefa/function_tool_kit
  • dokuinjs
  • @mjefi/instags
  • machine-ip
  • flawed-code-scanner
  • pantheon_site_management
  • postgres-markdown
  • reposier
  • gatsby-source-google-docs-team
  • work-webpack
  • vue-md-gen
  • @hitorisensei/markdown-readme-generator
  • @jswork/react-markdown-props
  • terraform2md
  • solidity-benchmark
  • utterance-to-markdown
  • @eventcatalog/plugin-doc-generator-asyncapi
  • type-graphql-to-md
  • @cloudcatalog/cli
  • @cloudcatalog/cli-testI am using this library to generate documentation for my projects, being integrated with blah.

:scroll: License

MIT © Ionică Bizău