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:
- 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. 🚀
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 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" })
// => "Hello World!"
-
Array|Object|String
data
: The input JSON data. -
String
prefix
: A snippet to add before each line.
- String The generated markdown result.
-
Array|Object|String
data
: The input JSON data. -
String
prefix
: A snippet to add before each line.
- Promise.<String> The generated markdown result.
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 🚀
-
—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
coffeetea. 🍵 -
—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! ❤️
If you are using this library in one of your projects, add it in this list. ✨
@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
@microfleet/schema2md
@mjefi/instags
@oasis-engine/oasis-run
@opas/plugin-doc
@s-ui/changelog
@servable/manifest
@servable/tools
@shelex/schema-tools
@sidneys/releasenotes
@solarity/hardhat-markup
@truto/truto-jsonata
@wii/swagger-plugin-transform-doc
@xygengcn/koa-api-docs
@yesand/asterism
bookmark2md
ccdown
chdown
chdown-workers
cli-demo3
cloudcastsdown
codexer
collman
component-docs-2md
cwq
dargstack_rgen
describe-dependencies
doc-cli
doc-vue
doc-vue3
dokuinjs
eddown
flawed-code-scanner
galaxy-vuepress-docs
gatsby-source-gdocs2md
gatsby-source-google-docs
gatsby-source-google-docs-sheets
gatsby-source-google-docs-team
git-diff-llm
github-repo-tools
gridsome-source-google-docs
heat-sfdx-tooling
joi-md-doc
jumia-travel-changelog
kbase-components
kindle-highlights
lab-changelog
lambda-docs-2md
laradown
lbdoc-p
lggn
machine-ip
make-postgres-markdown
merak-compile
mokker
msdown
my_ccdown
mysql-ksdb
node-red-contrib-json2md
notion2mdblog
npm-ex-xpi
p2doc
pantheon_site_management
parse-google-docs-json
platzi-virtual-machine
postgres-markdown
rap2doc
react-docgen-markdown
reposier
rober19-config
rush-archive-project-plugin
sfhdown
solidity-benchmark
tcdown
terraform2md
type-graphql-to-md
utterance-to-markdown
uxcore-tools
vue-md-gen
vue2markdown
-
work-webpack
I am using this library to generate documentation for my projects, being integrated with blah.