Package Health Score

66 / 100

security
No known security issues
popularity
Recognized
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
2.0.1	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.13.0	\|	09/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.12.0	\|	09/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.11.0	\|	06/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.10.0	\|	03/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (81,929)

GitHub Stars: 579
Forks: 80
Contributors: 30

Direct Usage Popularity

The npm package json2md receives a total of 81,929 downloads a week. As such, we scored json2md popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package json2md, we found that it has been starred 579 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 30
Funding: Yes

With more than 10 contributors for the json2md repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like json2md is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 8
Open PR: 0
Last Release: 12 months ago
Last Commit: 12 months ago

Further analysis of the maintenance status of json2md based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that json2md demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 9 years
Dependencies: 1 Direct
Versions: 37
Install Size: 38.9 kB
Dist-tags: 1
# of Files: 6
Maintainers: 1
TS Typings: Yes

json2md has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use json2md?

To help you get started, we've collected the most common ways that json2md is being used within popular public projects.

rei / rei-cedar / build / component-docs-build.js View on Github

const path = require('path')
const semverDiff = require('semver-diff')
const semver = require('semver')
const fs = require('fs-extra')
const json2md = require('json2md')
const vueDocgen = require('vue-docgen-api')

// Add convert for markdown anchor
json2md.converters.anchor = (anchor, json) =&gt; {
  if (!anchor.text) {
    return "";
  }

  return `[${anchor.text}](${anchor.source})`;
};

/**
 * convert .vue file into JSON object then convert to markdown file
 * @param {String} file -- file path of raw Vue component file
 * @param {Object} info -- packag.json
 */
function docsBuild(file, info) {
  console.log(`Processing file: ${file}\n`)
  const vueObj = vueDocgen.parse(file)

View more ways to use json2md

json2md

> 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.

☁️ Installation

# Using npm
npm install --save json2md

# Using yarn
yarn add json2md

📋 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)"
        ]
      }
    }
]))
// =&gt;
// # JSON To Markdown
// &gt; 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)
// ```

❓ Get Help

There are few ways to get help:

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

📝 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: "https://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": "" } }`
`table`	Table	An object containing the `headers` (`Array` of `String`s) and `rows` (`Array` of `Array`s or `Object`s).	`{ 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" })
// =&gt; "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.* The generated markdown result.

😋 How to contribute

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

💖 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 🚀
—I love books! I will remember you after years if you buy me one. 😁 📖
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. 🍵
—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! ❤️

💫 Where is this library used?

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

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

📜 License

json2md dependencies

indento

json2md development dependencies

tester

FAQs

What is json2md?

A JSON to Markdown converter. Visit Snyk Advisor to see a full health score report for json2md, including popularity, security, maintenance & community analysis.

Is json2md popular?

The npm package json2md receives a total of 81,929 weekly downloads. As such, json2md popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is json2md well maintained?

We found indications that json2md is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is json2md safe to use?

The npm package json2md was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 13:51 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (81,929)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use json2md?

json2md

☁️ Installation

📋 Example

❓ Get Help

📝 Documentation

json2md(data, prefix)

Params

Return

async

Params

Return

😋 How to contribute

💖 Support my projects

💫 Where is this library used?

📜 License

json2md dependencies

json2md development dependencies

FAQs

What is json2md?

Is json2md popular?

Is json2md well maintained?

Is json2md safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`json2md(data, prefix)`