markable
v0.0.7
Published
Make non-English Markdown plain text markable
Downloads
34
Readme
Markable
Markalbe allows you to write markdown document in any language. Markable translate your non-English Markdown syntax related symbols into English, so that they can be parse by any markdown parser.
Read this in other languages: English | 简体中文
Demo
Checkout the demo to see markable in action.
Installation
npm
npm install -s markable
Usage
Node
var markable = require('markable');
console.log(markable('》 青山一道同云雨,明月何曾是两乡。')); // > 青山一道同云雨,明月何曾是两乡。
Browser
You can use markable with marked
<!doctype html>
<html>
<head>
<meta charset="utf-8"/>
<title>Marked Markable in the browser</title>
</head>
<body>
<div id="content"></div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/markable.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
<script>
var text = '》 青山一道同云雨,明月何曾是两乡。\n\n···js\n Hello World\n···';
document.getElementById('content').innerHTML =
marked(markable(text));
</script>
</body>
</html>
Contributing
Contributions are always welcome, no matter how large or small. Before contributing, please read the Contributing.