@threema/threema-markup
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

threema-markup

CI

A markup parser and formatter for the markup language used in Threema.

Usage

The simplest way is to apply the markify function to text with markup.

import {markify} from '@threema/threema-markup';

const formatted = markify('*bold text with _italic_ *');
// Result: <span class="text-bold">bold text with <span class="text-italic">italic</span> </span>

By default, the following CSS class mapping is used:

  • Bold: text-bold
  • Italic: text-italic
  • Strikethrough: text-strike

But this can be customized:

import {TokenType, markify} from '@threema/threema-markup';

const formatted = markify('*bold text with _italic_ *', {
    [TokenType.Asterisk]: 'a',
    [TokenType.Underscore]: 'u',
    [TokenType.Tilde]: 't',
});
// Result: <span class="a">bold text with <span class="u">italic</span> </span>

Development

Setup

npm install

Building

npm run build

Testing

npm test

License

Licensed under either of

at your option.

Package Sidebar

Install

npm i @threema/threema-markup

Weekly Downloads

277

Version

1.1.0

License

MIT

Unpacked Size

44.8 kB

Total Files

9

Last publish

Collaborators

  • dbrgn
  • lgrahl
  • sillych