https://github.com/lhrun/md-editor

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...
https://github.com/lhrun/md-editor

editor markdown markdown-editor markdown-it markdown-viewer notes-app

Last synced: 8 months ago
JSON representation

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...

• Host: GitHub
• URL: https://github.com/lhrun/md-editor
• Owner: LHRUN
• License: mit
• Created: 2022-09-27T14:05:43.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-12T14:37:50.000Z (over 3 years ago)
• Last Synced: 2025-04-05T09:41:52.176Z (about 1 year ago)
• Topics: editor, markdown, markdown-editor, markdown-it, markdown-viewer, notes-app
• Language: TypeScript
• Homepage: https://songlh.top/md-editor/
• Size: 493 KB
• Stars: 19
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
md-editor



  md-editor is a markdown-it based markdown editor



## Preview

Link: [https://songlh.top/md-editor/](https://songlh.top/md-editor/)

![](https://s1.ax1x.com/2023/02/14/pST4lJP.png)

## Document

[基于markdown-it打造的markdown编辑器](https://songlh.top/2022/10/12/%E5%9F%BA%E4%BA%8Emarkdown-it%E6%89%93%E9%80%A0%E7%9A%84markdown%E7%BC%96%E8%BE%91%E5%99%A8/)

## Features

- [x] Menu Edit Button

- [x] Code Block Theme Switch

- [x] Sync scrolling

- [x] Generate toc list

- [x] Content state local cache

- [x] Multi file tree records

- [x] Download and upload file

- [x] Support UML and Katex syntax

## Getting Started

```

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

pnpm install

pnpm dev

```

## File List

```js

├─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

```