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

telegram-markdown-sanitizer

v0.0.11

Published

Telegram markdown sanitizer

Downloads

1,380

Readme

Telegram Markdown Sanitizer ✈️

Overview 🌐

telegram-markdown-sanitizer is a zero-dependency, TypeScript library ensuring Markdown used with the Telegram Bot API's Markdown V2 mode is valid. It sanitizes Markdown to comply with Telegram's Markdown Specification, transforming potentially invalid markdown into Telegram-compliant format by escaping invalid characters and maintaining valid markdown structures.

Problem Description 🚨

Using Telegram Bot API with Markdown V2 requires valid markdown conforming to Telegram's specifications. Invalid markdown input can lead to message failures or display errors. This library preprocesses markdown input, converting it to a valid format by escaping all inappropriate characters while preserving valid markdown elements.

Live Demo 👀

Installation 💻

npm install telegram-markdown-sanitizer

Features 🌟

  • Multiline Code Blocks**: Detects multiline code blocks and escapes backticks inside.
  • Single Line Code Blocks: Detects single line code blocks without escaping anything inside.
  • Links: Detects links and escapes special symbols inside them.
  • Special Symbols: Detects all other special symbols and escapes them, ensuring valid markdown output.

Upcoming Features 🔜

We are actively working on adding more features, including:

  • Formatting: Support for bold, italic, underline, and strikethrough text.

Usage 🛠️

Here is a basic example of how to use telegram-markdown-sanitizer:

import { sanitizeMarkdown } from 'telegram-markdown-sanitizer';

const inputMarkdown = "Your markdown string here";
const sanitizedMarkdown = sanitizeMarkdown(inputMarkdown);

console.log(sanitizedMarkdown);

API Documentation 📖

sanitizeMarkdown(input: string): string

Sanitizes markdown input by:

  • Escaping backticks inside multiline code blocks.
  • Preserving content inside single line code blocks.
  • Escaping all other special markdown symbols.

Parameters:

  • input: The markdown input (possibly invalid markdown).

Returns:

  • Sanitized markdown string (always valid markdown).

Contributing 🤝

Contributions are welcome! Please feel free to submit pull requests, report bugs, or suggest features.

License 📄

This project is licensed under the MIT License.

Author 👨‍💻

Illia Kurochkin