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)"
]
}
}
]))
// =>
// # 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)
// ```
โ 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: "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!"
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.
๐ 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
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!
๐ซ Where is this library used?
If you are using this library in one of your projects, add it in this list.
@sidneys/releasenotes
@microfleet/schema2md
@asyncapi/diff
@best/github-integration
@cypress/schema-tools
@eventcatalog/utils
@best/store
jumia-travel-changelog
npm-ex-xpi
heat-sfdx-tooling
@cobalt-engine/change-logger
lambda-docs-2md
@lm_fe/scripts
@myadbox/nebula-template-utils
@aligov/module-doc
@bonitasoft/dependency-list-to-markdown
@dschau/gatsby-source-google-docs
@gracexwho/model-card-generator
bookmark2md
@yiird-learn/vue3-ts-api-extractor
github-repo-tools
gridsome-source-google-docs
notion2mdblog
rap2doc
make-postgres-markdown
cwq
tcdown
sfhdown
@bwagener/gridsome-source-google-docs
@dididc/dc-extension
@flive/react-kit
@xygengcn/koa-api-docs
@shelex/schema-tools
@apica-io/asm-auto-deploy
gatsby-source-gdocs2md
@medyll/css-fabric-helper
cli-demo3
kbase-components
lggn
@e2y/bdd-dictionary-generator
parse-google-docs-json
doc-cli
react-docgen-markdown
lbdoc-p
doc-vue3
@oasis-engine/oasis-run
dargstack_rgen
chdown-workers
@feizheng/react-markdown-props
@klarna/postgres-to-docs
gatsby-source-google-docs-sheets
gatsby-source-google-docs
rober19-config
mokker
msdown
eddown
laradown
@s-ui/changelog
@eventcatalogtest/plugin-doc-generator-asyncapi
@hitorisensei/monorepo-readme-generator
joi-md-doc
lab-changelog
collman
doc-vue
describe-dependencies
node-red-contrib-json2md
p2doc
uxcore-tools
@gigsboat/cli
chdown
ccdown
@hitorisensei/markdown-readme-generator
codexer
dokuinjs
component-docs-2md
gatsby-source-google-docs-team
pantheon_site_management
postgres-markdown
reposier
solidity-benchmark
type-graphql-to-md
machine-ip
terraform2md
utterance-to-markdown
@eventcatalog/plugin-doc-generator-asyncapi
vue-md-gen
@mjefi/instags
@jswork/react-markdown-props
I am using this library to generate documentation for my projects, being integrated with blah.