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.
: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.
//
// 
//
// 
//
// 
//
// ## 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)
// ```
: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> The generated markdown result.
:question: 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. :bug:
- For direct and quick help, you can use Codementor. :rocket:
: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:
-
—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:
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
@aligov/module-doc@apica-io/asm-auto-deploy@asyncapi/diff@balmacefa/function_tool_kit@best/github-integration@best/store@bonitasoft/dependency-list-to-markdown@bwagener/gridsome-source-google-docs@cloudcatalog/cli@cloudcatalog/cli-test@cobalt-engine/change-logger@cypress/schema-tools@dididc/dc-extension@dlsl/hardhat-markup@dschau/gatsby-source-google-docs@e2y/bdd-dictionary-generator@enrico.piccinin/gitlab-tools@eventcatalog/plugin-doc-generator-asyncapi@eventcatalog/utils@eventcatalogtest/plugin-doc-generator-asyncapi@feizheng/react-markdown-props@flive/react-kit@gigsboat/cli@gracexwho/model-card-generator@haimmag/schema-tools@hankanman/postgres-to-docs@hitorisensei/markdown-readme-generator@hitorisensei/monorepo-readme-generator@jswork/react-markdown-props@klarna/postgres-to-docs@lm_fe/scripts@medyll/css-fabric-helper@mfbtech/changelog-generator@microfleet/schema2md@mjefi/instags@oasis-engine/oasis-run@opas/plugin-doc@r6d9/kol-tracker@r6d9/kol_tracker@s-ui/changelog@servable/manifest@servable/tools@shelex/schema-tools@sidneys/releasenotes@solarity/hardhat-markup@solarity/hardhat-migrate@truto/truto-jsonata@wii/swagger-plugin-transform-doc@xygengcn/koa-api-docs@yesand/asterismbookmark2mdccdownchdownchdown-workerscli-demo3cloudcastsdowncodexercollmancomponent-docs-2mdcwqdargstack_rgendescribe-dependenciesdoc-clidoc-vuedoc-vue3dokuinjseddownflawed-code-scannergalaxy-vuepress-docsgatsby-source-gdocs2mdgatsby-source-google-docsgatsby-source-google-docs-sheetsgatsby-source-google-docs-teamgit-diff-llmgithub-repo-toolsgridsome-source-google-docsheat-sfdx-toolingjoi-md-docjumia-travel-changelogkbase-componentskindle-highlightskol-trackerkol_analyzerlab-changeloglambda-docs-2mdlaradownlbdoc-plggnmachine-ipmake-postgres-markdownmcp-douban-servermerak-compilemokkermsdownmy_ccdownmysql-ksdbnode-red-contrib-json2mdnotion2mdblognpm-ex-xpip2docpantheon_site_managementparse-google-docs-jsonplatzi-virtual-machinepostgres-markdownrap2docreact-docgen-markdownreposierrober19-configrush-archive-project-pluginsfhdownsolidity-benchmarktcdownterraform2mdtype-graphql-to-mdutterance-to-markdownuxcore-toolsvue-md-genvue2markdownwork-webpackI am using this library to generate documentation for my projects, being integrated with blah.
:scroll: License
MIT © Ionică Bizău
