fragment/markdown/fragment_markdown.js

/**
 *  MarkdownFragment
 *  Compose markdown-code with Codestrates
 * 
 *  Copyright 2020, 2021 Rolf Bagge, Janus B. Kristensen, CAVI,
 *  Center for Advanced Visualization and Interaction, Aarhus University
 *    
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0

 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
**/


/* global webstrate, cQuery, Fragment, wpm */

wpm.onRemoved(()=>{
    Fragment.unRegisterFragmentType(MarkdownFragment);
});

/**
 * A fragment containing markdown
 *
 * Supports autodom insertion
 * @extends Fragments.Fragment
 * @hideconstructor
 * @memberof Fragments
 */
class MarkdownFragment extends Fragment {
    constructor(html) {
        super(html);
    }

    /**
     * Converts the markdown inside this fragment to html
     * @example
     * let renderedMarkdown = Fragment.one("#myMarkdownFragment").require();
     * @returns {Promise<HTMLElement>}
     */
    require(options) {
        return new Promise((resolve, reject)=>{
            requirejs(["showdown/showdown.min"], (showdown)=>{
                resolve(new showdown.Converter({
                    "strikethrough": true,
                    "tables": true,
                    "smoothLivePreview": true,
                    "openLinksInNewWindow": true,

                }).makeHtml(this.raw));
            });
        });
    }

    supportsAutoDom() {
        return true;
    }

    static type() {
        return "text/markdown";
    }
};window.MarkdownFragment = MarkdownFragment;

Fragment.registerFragmentType(MarkdownFragment);