https://github.com/kgar/ts-markdown
An extensible TypeScript markdown generator that takes JSON and creates a markdown document
https://github.com/kgar/ts-markdown
data-conversion data-converter extensible json json-to-markdown markdown markdown-writer open-source test-driven-development typescript typescript-library
Last synced: 4 months ago
JSON representation
An extensible TypeScript markdown generator that takes JSON and creates a markdown document
- Host: GitHub
- URL: https://github.com/kgar/ts-markdown
- Owner: kgar
- License: mit
- Created: 2022-07-12T16:34:06.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-12T04:29:23.000Z (9 months ago)
- Last Synced: 2025-08-16T12:43:33.398Z (5 months ago)
- Topics: data-conversion, data-converter, extensible, json, json-to-markdown, markdown, markdown-writer, open-source, test-driven-development, typescript, typescript-library
- Language: TypeScript
- Homepage: https://kgar.github.io/ts-markdown/
- Size: 938 KB
- Stars: 15
- Watchers: 2
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-markdown - ts-markdown - An extensible TypeScript markdown generator that takes JSON and creates a markdown document. (Convert to Markdown Tools / JSON to Markdown)
README
# ts-markdown
An extensible TypeScript markdown generator that takes JSON and creates a markdown document.
[๐ Docs](https://kgar.github.io/ts-markdown/) | [๐ฎ Playground (Live Demo)](https://kgar.github.io/ts-markdown/playground.html)
---
- [Quick Start](#quick-start)
- [Extensibility](#extensibility)
- [Compatibility](#compatibility)
- [Why This Project?](#why-this-project)
- [๐ Credit](#-credit)
- [Credit to json2md](#credit-to-json2md)
- [Credit to Markdown Guide](#credit-to-markdown-guide)
- [๐ Contribution Guidelines](#-contribution-guidelines)
- [License](#license)
## Quick Start
Install **ts-markdown**:
```sh
npm install ts-markdown
# or "yarn add ts-markdown"
```
Generate some markdown:
```ts
import { tsMarkdown } from 'ts-markdown';
// Make markdown entries
const entries = [
{
h4: 'Hello, world!',
},
{
blockquote: "Let's generate markdown!",
},
{ p: 'Generating markdown from data can be simple. All you need are:' },
{
ol: [
'objects',
'a function',
{
text: ['and a place to run ', { emoji: 'checkered_flag' }],
},
],
},
];
return tsMarkdown(entries); // returns the markdown document as a string
```
And the result is:
```md
#### Hello, world!
> Let's generate markdown!
Generating markdown from data can be simple. All you need are:
1. objects
2. a function
3. and a place to run :checkered_flag:
```
For more information about supported markdown elements, view the [type docs](https://kgar.github.io/ts-markdown/modules.html). All support markdown elements end with `Entry`, such as `LinkEntry`, `ImageEntry`, `UnorderedListEntry`, and so on.
For more examples of **generating markdown**, check out the [cookbook](https://kgar.github.io/ts-markdown/pages/cookbook.html).
## Extensibility
You can extend **ts-markdown** to render your own custom elements or even override existing renderers.
For more information on extending **ts-markdown**, see [Extending ts-markdown](https://kgar.github.io/ts-markdown/pages/extending-ts-markdown.html).
## Compatibility
**ts-markdown** is written in TypeScript and node JS. It works with node JS v16.x and higher. Earlier versions may also work, but it is not guaranteed.
## Why This Project?
I am an avid user of [Obsidian.md](https://www.obsidian.md), and as I build my vaults of information, I sometimes need to convert JSON into markdown in a programmatic way. I may be working on a project to crunch some JSON and build articles, and having the ability to offload the complexity of rendering markdown to a library would be ideal. Additionally, having TypeScript typing support sweetens the deal for me.
Because I could not find an active / monitored library that handled the level of complexity I need when building my Obsidian markdown documents, I decided to make it myself.
## ๐ Credit
### Credit to [json2md](https://github.com/IonicaBizau/json2md)
This library is heavily inspired by [Ionicฤ Bizฤu's](https://github.com/IonicaBizau) [json2md](https://github.com/IonicaBizau/json2md) library, which was the only highly starred repo I could find that offered the kind of functionality I wanted. I also like the modeling the author chose, so I have patterned mine after theirs, adding and expanding in ways that make sense to me.
### Credit to [Markdown Guide](https://www.markdownguide.org/)
The unit tests in this library cover almost all cases defined in [Markdown Guide](https://www.markdownguide.org/), an excellent website for getting exactly the details needed for writing good markdown. Any best practices that I've applied are most likely based on this website.
## ๐ Contribution Guidelines
Have an idea? Found a bug? Seeย [how to contribute](https://github.com/kgar/data-driven-markdown/blob/main/CONTRIBUTING.md).
## License
[MIT](https://github.com/kgar/data-driven-markdown/blob/main/LICENSE) ยฉ [KGar](https://github.com/kgar)