0.0.20160224 • Published 8 years ago

marked-plus-renderer v0.0.20160224

Weekly downloads
2
License
MIT
Repository
github
Last release
8 years ago

marked-plus-renderer

homepage

wrap marked-plus as a full-feature markdown renderer

install

npm install marked-plus-renderer --save

usage

sample

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>demo</title>
    <link rel="stylesheet" href="$path/to/marked-plus-renderer/dist/libs.css">
</head>
<body>
    <div id="container" class="markdown-body"></div>
    <script src="$path/to/marked-plus-renderer/dist/libs.js"></script>
    <script src="$path/to/marked-plus-renderer/dist/renderer.js"></script>
    <script>
        fetch('$path/to/marked-plus-renderer/doc/features.md').then(function(markdownString){
            mpr.render(document.getElementById('container'), markdownString);
        });
    </script>
</body>
</html>

use with npm

npm install marked-plus-renderer --save-dev
<!--...-->
    <link rel="stylesheet" href="$path/to/marked-plus-renderer/dist/libs.css">
<!--...-->
    <script src="$path/to/marked-plus-renderer/dist/libs.js"></script>
    <script src="$path/to/main.js"></script>
<!--...-->

in main.js

import mpr from 'marked-plus-renderer'; 

// your codes

mpr.render(container, markdownString);

demo

features

  • all basic markdown features(headings, tables, etc.)
  • gfm-like check-list
  • code highlighting
  • definition list
  • footnote
  • graph
  • sequence diagram
  • gantt diagram
  • flowchart
  • latex math typesetting
  • emoji
  • html/js/css injection