Skip to content

md-editor is a markdown-it based markdown editor, including sync scrolling, multi file record,upload and download, generate toc, menu edit btn, code block theme switch, content state local cache...

License

Notifications You must be signed in to change notification settings

LHRUN/md-editor

Repository files navigation

md-editor

md-editor is a markdown-it based markdown editor

Preview

Link: https://songlh.top/md-editor/

Document

基于markdown-it打造的markdown编辑器

Features

  • Menu Edit Button
  • Code Block Theme Switch
  • Sync scrolling
  • Generate toc list
  • Content state local cache
  • Multi file tree records
  • Download and upload file
  • Support UML and Katex syntax

Getting Started

git clone https://github.com/LHRUN/md-editor.git
pnpm install
pnpm dev

File List

├─components        
  ├─icons
  ├─multiFile // Multi file drawer
  └─toolbar // Top Menu

├─context        
  ├─file // multi file provider
  └─index // app provider

├─hooks
  └─event.ts // event hook

├─views
  └─editor // editor page

└─utils
   ├─constants
   ├─common
   ├─editor // editor utils
   ├─md // markdown-it instance
   ├─scroll // sync scroll
   ├─storage // local cache
   ├─multiFile
   └─toc

About

md-editor is a markdown-it based markdown editor, including sync scrolling, multi file record,upload and download, generate toc, menu edit btn, code block theme switch, content state local cache...

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published