# chunmde

> Markdown editor based on codemirror 6

Latest version **0.2.0** (published 2024-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install chunmde
pnpm add chunmde
yarn add chunmde
bun add chunmde
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2024-10-23 |
| First published | 2022-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 2.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 14 |
| Author | MadeY |
| Maintainers | madey |
| Keywords | markdown, editor, codemirror 6 |

## Links

- npm: https://www.npmjs.com/package/chunmde
- Repository: https://github.com/madeyoga/chunchunmaru-mde
- Homepage: https://github.com/madeyoga/chunchunmaru-mde#readme
- Issues: https://github.com/madeyoga/chunchunmaru-mde/issues
- npm.io page: https://npm.io/package/chunmde

## Dependencies (4)

- [codemirror](https://npm.io/package/codemirror.md) 6.0.1
- [@codemirror/view](https://npm.io/package/@codemirror/view.md) 6.34.1
- [@codemirror/state](https://npm.io/package/@codemirror/state.md) 6.4.1
- [@codemirror/lang-markdown](https://npm.io/package/@codemirror/lang-markdown.md) 6.3.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2024-10-23
- 0.1.0 — 2024-10-14
- 0.0.10 — 2024-10-13
- 0.0.9 — 2022-07-25
- 0.0.8 — 2022-07-25
- 0.0.7 — 2022-07-24
- 0.0.6 — 2022-07-23
- 0.0.5 — 2022-07-15
- 0.0.4 — 2022-07-15
- 0.0.3 — 2022-07-12
- 0.0.2 — 2022-07-11
- 0.0.1 — 2022-07-11

## 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/)

[Demo page](https://madeyoga.github.io/chunchunmaru-mde/)

## Features
- Key bindings
- Toolbars
- Commands:
  - heading
  - italic <Ctrl+i>
  - bold <Ctrl+b>
  - quote <Ctrl+Shift+e>
  - code <Ctrl+e>
  - link <Ctrl+k>
  - Unordered list <Ctrl+Shift+8>

## Usage

#### Browser
```html
<!doctype html>
<html>
<head>
  <meta charset="utf-8"/>
  <title>Markdown editor in the browser</title>
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/chunmde@x.y.z/dist/chunmde.min.css">
</head>
<body>
  <div id="editor-container"></div>
  <script src="https://cdn.jsdelivr.net/npm/chunmde@x.y.z/dist/chunmde.bundle.min.js"></script>
  <script>
    const editor = new ChunMDE('editor-container')
    const value = editor.getValue()
    console.log(value)
  </script>
</body>
</html>
```

## 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 :>

---
_Source: https://npm.io/package/chunmde · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._