markdo

1.0.2 • Public • Published

markdo

Very tiny (100 LOC) markdown formatter

Instalation

npm install --save markdo

Supported styles

  • # Header 1 (heading1)
  • ## Heading 2 (heading2)
  • ### Heading 3 (heading3)
  • **Bold** (bold)
  • _Italic_ (italic)
  • [link](url) (link)
  • > Quote (quote)
  • - Bullted list (bulletedList)
  • 1. Ordered list (orderedList)
  • [ ] Task list (taskList)

Usage

import markdo from 'markdo';
 
/**
 * markdo(text: string, style: string, cursorPosition: {start: number, end: number});
 */
const line = 'Think of RxJS as Lodash for events.';
console.log(markdo(line, 'bulletedList', {start: 13, end: 13}));
 
/*
Think of 
 
- RxJS
 
 as Lodash for events.
*/
 
// you can specify selection of the text as range
console.log(markdo(line, 'bold', {start: 9, end: 13}));
 
// Think of **RxJS** as Lodash for events.

License

MIT

Package Sidebar

Install

npm i markdo

Weekly Downloads

1

Version

1.0.2

License

MIT

Unpacked Size

5.74 kB

Total Files

4

Last publish

Collaborators

  • antonkalinin