Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Variables

domtoimage

domtoimage: domtoimage

Functions

confetti

  • confetti takes a single optional object. When window.Promise is available, it will return a Promise to let you know when it is done. When promises are not available (like in IE), it will return null. You can polyfill promises using any of the popular polyfills. You can also provide a custom promise implementation to confetti through:

     const MyPromise = require('some-promise-lib');
    const confetti = require('canvas-confetti');
    confetti.Promise = MyPromise;

    If you call confetti multiple times before it is done, it will return the same promise every time. Internally, the same canvas element will be reused, continuing the existing animation with the new confetti added. The promise returned by each call to confetti will resolve once all animations are done.

    Parameters

    Returns Promise<undefined> | null

dayjs

  • Parameters

    • Optional date: string | number | Date | Dayjs

    Returns Dayjs

  • Parameters

    • Optional date: string | number | Date | Dayjs
    • Optional format: OptionType
    • Optional strict: boolean

    Returns Dayjs

  • Parameters

    • Optional date: string | number | Date | Dayjs
    • Optional format: OptionType
    • Optional locale: string
    • Optional strict: boolean

    Returns Dayjs

juice

  • Parameters

    Returns string

Const markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
    md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
    html: true,
    linkify: true,
    typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return hljs.highlight(lang, str, true).value;
    } catch (__) {}
    }

    return ''; // use external default escaping
    }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return '<pre class="hljs"><code>' +
    hljs.highlight(lang, str, true).value +
    '</code></pre>';
    } catch (__) {}
    }

    return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
    }
    });

    Returns markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
    md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
    html: true,
    linkify: true,
    typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return hljs.highlight(lang, str, true).value;
    } catch (__) {}
    }

    return ''; // use external default escaping
    }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return '<pre class="hljs"><code>' +
    hljs.highlight(lang, str, true).value +
    '</code></pre>';
    } catch (__) {}
    }

    return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
    }
    });

    Parameters

    Returns markdownit

  • Main parser/renderer class.

    Usage
    // node.js, "classic" way:
    var MarkdownIt = require('markdown-it'),
    md = new MarkdownIt();
    var result = md.render('# markdown-it rulezz!');

    // node.js, the same, but with sugar:
    var md = require('markdown-it')();
    var result = md.render('# markdown-it rulezz!');

    // browser without AMD, added to "window" on script load
    // Note, there are no dash.
    var md = window.markdownit();
    var result = md.render('# markdown-it rulezz!');

    Single line rendering, without paragraph wrap:

    var md = require('markdown-it')();
    var result = md.renderInline('__markdown-it__ rulezz!');
    Example
    // commonmark mode
    var md = require('markdown-it')('commonmark');

    // default mode
    var md = require('markdown-it')();

    // enable everything
    var md = require('markdown-it')({
    html: true,
    linkify: true,
    typographer: true
    });
    Syntax highlighting
    var hljs = require('highlight.js') // https://highlightjs.org/

    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return hljs.highlight(lang, str, true).value;
    } catch (__) {}
    }

    return ''; // use external default escaping
    }
    });

    Or with full wrapper override (if you need assign class to <pre>):

    var hljs = require('highlight.js') // https://highlightjs.org/

    // Actual default values
    var md = require('markdown-it')({
    highlight: function (str, lang) {
    if (lang && hljs.getLanguage(lang)) {
    try {
    return '<pre class="hljs"><code>' +
    hljs.highlight(lang, str, true).value +
    '</code></pre>';
    } catch (__) {}
    }

    return '<pre class="hljs"><code>' + md.utils.escapeHtml(str) + '</code></pre>';
    }
    });

    Parameters

    Returns markdownit

Generated using TypeDoc