npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-markdown

v1.2.0

Published

An extensible TypeScript markdown generator that takes JSON and creates a markdown document.

Downloads

11,485

Readme

ts-markdown

An extensible TypeScript markdown generator that takes JSON and creates a markdown document.

📖 Docs | 🎮 Playground (Live Demo)


Quick Start

Install ts-markdown:

npm install ts-markdown
# or "yarn add ts-markdown"

Generate some markdown:

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:

#### 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. 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.

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.

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, 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

This library is heavily inspired by Ionică Bizău's 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

The unit tests in this library cover almost all cases defined in Markdown Guide, 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.

License

MIT © KGar