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:1234/ in your browser

License

MIT

Copyright © 2015 - 2024 Tyler Liu


Todo

  • Replace jQeury Layout with split-grid
    • ant design splitter may be better
  • Get rid of jQuery
  • Write Playwright tests
  • Support mobile devices
    • codemirror support mobile devices
  • Make it an easy-to-embed library
  • Replace mermaid with lightweight alternatives
    • elk.js + dynamically render to get element size
  • Make an app for ebook authoring
  • Rewrite markdown-core, a mono repo for all the plugins
  • Remove support for class diagram since it is not stable
  • Upgrade all dependencies to latest version, no exception
  • Must have a render finished event
    • mdc.init must be a Promise
  • bug: <div id="mdp-container" style={{ height: '99%' }}>
    • without 99%, jQuery Layout will display nothing
  • bug: click anchor link, toolbar becomes invisible
  • Creat a VS Code extension
  • No eslint-disable
  • Enable react strict mode
    • only after we could properly dispose all side effects
  • Update modal forms UI
  • gantt diagram x-axis format should be part of the diagram code, not a settings
  • simplify css file