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

markdown-truncate

v1.1.1

Published

A zero-dependency, vanilla JavaScript utility to truncate markdown text.

Downloads

2,313

Readme

Markdown Truncate

npm version

A zero-dependency, vanilla JavaScript utility to truncate markdown text.

It's like substring but with superpowers, since it respects your input text's markdown emphasis markers.

Check the demo

Installation

npm install markdown-truncate

or

yarn add markdown-truncate

Usage

Import the truncate function from markdown-truncate; this is its signature:

function truncateMarkdown (inputText: string, options: object)

Options

These are the option flags you can provide to markdown-truncate:

| Flag | Description | Default value | Required | |----------|------------------------------------------------------------------|---------------|----------| | limit | The max number of characters the output string should have | - | Yes | | ellipsis | Specifies whether to append ellipsis ... to the truncated text | false | No |

Example

import truncateMarkdown from 'markdown-truncate'

truncateMarkdown('markdown *is* __properly__ truncated', {
  limit: 15,
  ellipsis: true
}) // returns 'markdown *is* __pro__...'

Demo

Check out the live demo here.