Skip to content

tylerlong/markdown-plus

Repository files navigation

Markdown Plus

icon

Markdown Plus ("M+" or "mdp" for short) is a markdown editor with extra features.

Markdown Plus

Online Demo

Markdown Plus

Features

  • GitHub flavored markdown
  • Live preview with scroll sync
  • Source code highlight
  • Footnote
  • Table of Contents
  • Task list
  • Abbreviation
  • Custom container
  • Definition list
  • Emoji, Font Awesome icon
  • Mathematical formula, AsciiMath
  • Mermaid: Flowchart, Sequence diagram, Gantt diagram, Class diagram
  • Vim mode, Emacs mode
  • Themes
  • Plugins
  • Chart.js: line, bar, radar, polar area, pie, doughnut and bubble

Setup & Run

Optionally ⭐ this project, then:

fork it
git clone to your local
yarn install
yarn serve
open http://localhost:8080/ in your browser

How to use Markdown Plus in your projects

Please take src/index.html as example.

License

MIT

Copyright © 2015 - 2024 Tyler Liu


Todo

  • Get rid of jQuery
  • bug: scroll by url hash, source code position is not accurate
    • issue disappeared after replacing babel with ts
  • use TypeScript
  • Replace jQeury Layout with split-grid
  • Use parcel instead of webpack