An open API service indexing awesome lists of open source software.

https://github.com/versyxdigital/mkeditor

MKEditor - the simple markdown editor.
https://github.com/versyxdigital/mkeditor

bootstrap crowdstrike editing editor electron fontawesome highlightjs html javascript js markdown markdown-it microsoft monaco-editor ts typescript vscode

Last synced: 4 months ago
JSON representation

MKEditor - the simple markdown editor.

Awesome Lists containing this project

README

          

[![Tests](https://github.com/versyxdigital/mkeditor/actions/workflows/tests.yml/badge.svg)](https://github.com/versyxdigital/mkeditor/actions/workflows/tests.yml)

# MKEditor

The simple markdown editor.

| Platform | Stable | Download |
| -------- | ------- | ------- |
| Windows | v3.1.0 | [exe](https://github.com/versyxdigital/mkeditor/releases/download/v3.1.0/mkeditor-setup-v3.1.0-x86_64.zip) |
| MacOS | v3.1.0 | [pkg](https://github.com/versyxdigital/mkeditor/releases/download/v3.1.0/mkeditor-setup-v3.1.0_x86_64.pkg) |
| Linux | v3.1.0 | [deb](https://github.com/versyxdigital/mkeditor/releases/download/v3.1.0/mkeditor-setup-v3.1.0_amd64.deb) |

Use it through your [browser](https://versyxdigital.github.io/mkeditor/web/) or download for desktop. More documentation is available at the [website](https://versyxdigital.github.io/mkeditor).

![MKEditor](https://versyxdigital.github.io/mkeditor/assets/demo-dark.png)
![MKEditor](https://versyxdigital.github.io/mkeditor/assets/demo.png)

# Welcome

Thank you for choosing MKEditor 😊, I hope you find this tool useful for all your markdown needs!

If you have any issues or questions, please feel free to submit an [issue](https://github.com/versyxdigital/mkeditor/issues).

---

Open the help menu using the button at the top right for a complete list of editor shortcuts.

You can also view a cheatsheet [here](https://versyxdigital.github.io/mkeditor/shortcuts).

---

MKEditor fully supports the [CommonMark](https://commonmark.org/) spec and comes with a few additional goodies.

**Great** support for _custom_ styling with:

- Bootstrap
- Fontawesome
- Highlight.js

Create alerts:

```md
::: primary
✨ Create alerts
:::
```

Format some code:

```javascript
document.addEventListener('DOMContentLoaded', () => {
document.body.write('Syntax-highlighted, copyable codeblock!')
})
```

MKEditor also includes a built-in, resizable preview renderer and support for exporting your markdown to HTML, with or without styles 🚀.

Customize your settings, switch between light mode and dark mode, write some documents and have fun!

Built with ❤️ by [Versyx Digital](https://github.com/versyxdigital)