https://github.com/madeyoga/chun-mde

Markdown editor based on codemirror 6
https://github.com/madeyoga/chun-mde

codemirror6 editor markdown markdown-editor

Last synced: 4 months ago
JSON representation

Markdown editor based on codemirror 6

• Host: GitHub
• URL: https://github.com/madeyoga/chun-mde
• Owner: madeyoga
• License: mit
• Created: 2021-05-26T11:51:37.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T15:22:58.000Z (4 months ago)
• Last Synced: 2024-10-28T13:14:42.905Z (4 months ago)
• Topics: codemirror6, editor, markdown, markdown-editor
• Language: TypeScript
• Homepage: https://madeyoga.github.io/chun-mde/
• Size: 489 KB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# chunchunmaru-mde

[![](https://data.jsdelivr.com/v1/package/npm/chunmde/badge)](https://www.jsdelivr.com/package/npm/chunmde)

![npm](https://img.shields.io/npm/dt/chunmde?style=flat-square)

![NPM Version](https://img.shields.io/npm/v/chunmde)

Markdown editor based on [codemirror6](https://codemirror.net/)

## Features

- Key bindings

- Toolbars

- Commands:

  - heading

  - italic 

  - bold 

  - quote 

  - code 

  - link 

  - Unordered list 

- Plugins:

  - Image upload

## Usage

#### Browser

```html

  

  Markdown editor in the browser

  

  


  

  

    const { createChunEditor, createImageUploadPlugin } = Chun

    

    const imageUploadPlugin = createImageUploadPlugin({

      imageUploadUrl: "", 

      imageFormats: ["image/jpg", "image/jpeg", "image/gif", "image/png", "image/bmp", "image/webp"],

    })


    const editor = createChunEditor({

      doc: initialContent.value,

      lineWrapping: true,

      indentWithTab: true,

      toolbar: true,

    })

    .use(imageUploadPlugin)

    .mount("editor-container")

    console.log(editor.getValue())

  

```

## Contribute

- [Fork the repository](https://github.com/madeyoga/chunchunmaru-mde.git)!

- Clone your fork: `git clone https://github.com/your-username/chunchunmaru-mde.git`

- Create your feature branch: `git checkout -b my-new-feature`

- Commit your changes: `git commit -am 'Add some feature'`

- Push to the branch: `git push origin my-new-feature`

- Submit a pull request :>