habitica-markdown

A markdown-it module pre-configured for use in Habitica

Usage

npm install habitica-markdown --save
bower install habitica-markdown --save

In Node with browserify/webpack/etc:

var md = require('habitica-markdowm');
md.render('_markdown_ is **awesome**');

In a browser with script tag

var md = window.habiticaMarkdown;
md.render('_markdown_ is **awesome**');

Pre-configured Settings and Plugins

Habitica Markdown comes pre-configured with

• Raw urls get converted to links with the linkify setting set to true
• Links open in new windows with markdown-it-link-attributes
• Images automatically turn into links with markdown-it-linkify-images
• Emojis parsed by habitica-markdown-emoji

Notes

Emoji

The emoji come pre-styled with:

.habitica-emoji {
  height: 1.5em;
  width: 1.5em;
}

If you'd like to override these values, you may need to apply the !important keyword to your css.

.habitica-emoji {
  height: 100px !important;
}