Skip to content

TakunMaii/MaikeDown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MaikeDown - A simple MD-like rich text compiler

MaikeDown is a simple Markdown-like rich text compiler for web use.

Usage

Import maikedown.js

<script src="path/to/maikedown.js"></script>

Import default-maikedown.css, which is alternative, but something will be strange without a css like that. You can also write your own css.

<link rel="stylesheet" href="path/to/default-maikedown.css">

Use maike(content) to convert your maikedown text to html.

const view = document.getElementById("example");
view.innerHtml=maike(content);

This compiler doesn't support a math parsing. If you need one, it is recommended to import Mathjax. To do so, just add this to your head (or other place you'd like).

<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>

To ensure the order between the maikedown parsing and the mathjax parsing, you could manually invoke MathJax.typesetPromise() like this.

const maikeit = ()=>{
    //firstly, do maikedown
    const mainview = document.getElementById("input");
    const showview = document.getElementById("show");
    const parsed = maike(mainview.value);
    showview.innerHTML = parsed;
    console.log(parsed);
    //then, do mathjax
    MathJax.typesetPromise()
    .then(() => {
        console.log("MathJax rendering complete.");
    })
    .catch((err) => console.log(err.message));
    //the order is alternative
}

About

A simple Markdown-like rich text compiler.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published