Netsyms/easy-markdown-editor
2
0
Fork 0
mirror of https://github.com/Ionaru/easy-markdown-editor synced 2025-07-18 15:34:28 -06:00
Code Issues Releases Wiki Activity

Update readme of v3 branch

Browse Source
This commit is contained in:
Jeroen akkerman 2025-05-01 18:44:49 +02:00
parent ee0aa6f0d1
commit 580e01333b
3 changed files with 58 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,8 +1,7 @@
# EasyMDE - Markdown Editor
[![npm version](https://img.shields.io/npm/v/easymde.svg?style=for-the-badge)](https://www.npmjs.com/package/easymde)
[![npm version](https://img.shields.io/npm/v/easymde/next.svg?style=for-the-badge)](https://www.npmjs.com/package/easymde/v/next)
[![Build Status](https://img.shields.io/github/actions/workflow/status/ionaru/easy-markdown-editor/cd.yaml?branch=master&style=for-the-badge)](https://github.com/Ionaru/easy-markdown-editor/actions?query=branch%3Amaster)
[![npm @v3-alpha version](https://img.shields.io/npm/v/easymde/v3-alpha.svg?style=for-the-badge)](https://www.npmjs.com/package/easymde/v/v3-alpha)
[![Build Status](https://img.shields.io/github/actions/workflow/status/ionaru/easy-markdown-editor/alpha.yaml?branch=v3&style=for-the-badge)](https://github.com/Ionaru/easy-markdown-editor/actions?query=branch%3Av3)
> This repository is a fork of
> [SimpleMDE, made by Sparksuite](https://github.com/sparksuite/simplemde-markdown-editor/).
@ -18,7 +17,7 @@ The editor is entirely customizable, from theming to toolbar buttons and javascr
[**Try the demo**](https://stackblitz.com/edit/easymde)
[![Preview](https://user-images.githubusercontent.com/3472373/51319377-26fe6e00-1a5d-11e9-8cc6-3137a566796d.png)](https://stackblitz.com/edit/easymde)
[![Preview](https://github.com/user-attachments/assets/54fcc425-39cd-462f-aaa3-934524c49fd6)](https://stackblitz.com/edit/easymde)
## Quick access

1
src/easymde.ts
View File

@ -128,6 +128,7 @@ export class EasyMDE {
state: EditorState.create({
doc: this.#element.value,
extensions: [
EditorView.lineWrapping,
syntaxHighlighting(highlightStyle),
syntaxHighlighting(defaultHighlightStyle),
markdown({

54
test/screenshot.html Normal file
View File

@ -0,0 +1,54 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Document</title>
<link rel="stylesheet" href="../dist/browser/easymde.css" />
<script
src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/js/fontawesome.min.js"
integrity="sha512-PoFg70xtc+rAkD9xsjaZwIMkhkgbl1TkoaRrgucfsct7SVy9KvTj5LtECit+ZjQ3ts+7xWzgfHOGzdolfWEgrw=="
crossorigin="anonymous"
referrerpolicy="no-referrer"
></script>
<script
src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/js/solid.min.js"
integrity="sha512-wabaor0DW08KSK5TQlRIyYOpDrAfJxl5J0FRzH0dNNhGJbeUpHaNj7up3Kr2Bwz/abLvVcJvDrJL+RLFcyGIkg=="
crossorigin="anonymous"
referrerpolicy="no-referrer"
></script>
<style>
body {
/* background-color: grey; */
}
</style>
</head>
<body>
<textarea id="my-text-area">
# EasyMDE
Easy Markdown editing, with inline styling! Format **visually** and *beautifully* using the toolbar, shortcuts or pure Markdown. This editor features powerful functionality combined with incredible easy-of-use.
## Features
* Spell checking
* Autosaving
* Auto-continue lists
* Multiple preview modes
* Theming support
* Full customization
* An extensive API
* So much more!
</textarea
>
<script type="module">
import { EasyMDE } from "../dist/browser/easymde.min.js";
window.x = new EasyMDE({
element: document.getElementById("my-text-area"),
toolbar: true,
statusbar: true,
});
</script>
</body>
</html>