smartmd

Markdown editor support most syntax

Usage no npm install needed!

<script type="module">
  import smartmd from 'https://cdn.skypack.dev/smartmd';
</script>

README

Smartmd

Documentation | 中文文档

Software License Software License

A markdown text editor compatible almost all markdown syntax, like Mathematical formula、flowchart、upload images...

Screenshots

editor demo: Demo
js render page Demo
php render page Demo

Get smartmd

npm install smartmd 

<head>
<link rel="stylesheet" href="dist/smartmd.min.css">
<script src="dist/smartmd.min.js"></script>
</head>

Quickstart

var editor = new Smartmd({
   el: "#editor",
   height: "400px"
});

Build Setup

# install reference
npm install smartmd 

# build for development
npm run dev

# build for production
npm run build

Features

  • Markdown syntax parse by Markdown-It and it's plugins
  • LaTeX mathematical expressions using KaTeX
  • Diagrams and flowcharts using Mermaid
  • Live preview
  • Emoji
  • Images upload (need server)

Issue

welcome repo bug reports, feature requests or optimization method.

Reference:

  • CodeMirror link
  • Simplemde-markdown link
  • markdown-it (markdown render) link
  • mermaid (flowchart) link