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.
# Using npm
npm install --save json2md
# Using yarn
yarn add json2md
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.
//
// 
//
// 
//
// 
//
// ## 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)
// ```
There are few ways to get help:
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!"
data: The input JSON data.prefix: A snippet to add before each line.data: The input JSON data.prefix: A snippet to add before each line.Have an idea? Found a bug? See how to contribute.
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:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a coffee tea. :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! :heart:
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/releasenotesmerak-compile@best/storejumia-travel-changelognpm-ex-xpidoc-vue3@feizheng/react-markdown-propsheat-sfdx-tooling@cobalt-engine/change-loggerlambda-docs-2mdservable-manifest@gracexwho/model-card-generatorrap2doc@dschau/gatsby-source-google-docsrush-archive-project-pluginsfhdowntcdownbookmark2mdcwq@bonitasoft/dependency-list-to-markdowngithub-repo-toolsgridsome-source-google-docsnotion2mdblogkindle-highlightsmake-postgres-markdown@dlsl/hardhat-markup@aligov/module-doc@opas/plugin-doc@xygengcn/koa-api-docs@dididc/dc-extensionparse-google-docs-jsoncli-demo3gatsby-source-gdocs2mdkbase-componentslbdoc-pchdown-workers@bwagener/gridsome-source-google-docsdoc-cligalaxy-vuepress-docsdargstack_rgenreact-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-toolsrober19-config@klarna/postgres-to-docs@wii/swagger-plugin-transform-doccloudcastsdowneddownmsdownlaradownmy_ccdownmokkergatsby-source-google-docsgatsby-source-google-docs-sheetsplatzi-virtual-machinechdown@yesand/asterismccdowndoc-vue@hitorisensei/monorepo-readme-generatoruxcore-tools@gigsboat/clijoi-md-doc@everything-registry/sub-chunk-1986describe-dependencieslab-changelognode-red-contrib-json2mdp2doc@eventcatalogtest/plugin-doc-generator-asyncapi@solarity/hardhat-markup@s-ui/changelogcomponent-docs-2mdcodexer@balmacefa/function_tool_kitdokuinjs@mjefi/instagsmachine-ipflawed-code-scannerpantheon_site_managementpostgres-markdownreposiergatsby-source-google-docs-teamwork-webpackvue-md-gen@hitorisensei/markdown-readme-generator@jswork/react-markdown-propsterraform2mdsolidity-benchmarkutterance-to-markdown@eventcatalog/plugin-doc-generator-asyncapitype-graphql-to-md@cloudcatalog/cli@cloudcatalog/cli-testI am using this library to generate documentation for my projects, being integrated with blah.FAQs
A JSON to Markdown converter.
The npm package json2md receives a total of 93,068 weekly downloads. As such, json2md popularity was classified as popular.
We found that json2md demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.