Mendel

Mendelium is the editor that powers Marvelous. This is based on SimpleMDE by nextwebs

SimpleMDE - Markdown Editor

A drop-in JavaScript textarea replacement for writing beautiful and understandable markdown. The WYSIWYG-esque editor allows users to modify the markdown with toolbar buttons and shortcuts. WYSIWYG editors that produce HTML are often complex and buggy. Markdown solves this problem in many ways, but is less visually clear while editing. SimpleMDE has been designed to bridge this gap for non-technical users who are less familiar with or just learning Markdown syntax.

Demo

Quick start

SimpleMDE is available on jsDelivr. Font Awesome is available on MaxCDN. Please note, jsDelivr may take a few days to update to the latest release.

<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/latest/css/font-awesome.min.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.css">
<script src="//cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>

And then load SimpleMDE on the first textarea on a page

<script>
var simplemde = new SimpleMDE();
simplemde.render();
</script>

Use a specific textarea

Pure JavaScript method

<script>
var simplemde = new SimpleMDE(document.getElementById("MyID"));
simplemde.render();
</script>

jQuery method

<script>
var simplemde = new SimpleMDE($("#MyID")[0]);
simplemde.render();
</script>

Get the content

simplemde.value();

Configuration

element: The DOM element for the textarea to use. Defaults to the first textarea on the page.
status: If set to false, hide the status bar. Defaults to true.
- Optionally, you can set an array of status bar elements to include, and in what order.
toolbar: If set to false, hide the toolbar. Defaults to true.
autofocus: If set to true, autofocuses the editor. Defaults to false.
lineWrapping: If set to false, disable line wrapping. Defaults to true.
indentWithTabs: If set to false, indent using spaces instead of tabs. Defaults to true.
tabSize: If set, customize the tab size. Defaults to 2.
autosave: Saves the text that's being written. It will forget the text when the form is submitted.
- enabled: If set to true, autosave the text. Defaults to false.
- unique_id: You must set a unique identifier so that SimpleMDE can autosave. Something that separates this from other textareas.
- delay: Delay between saves, in milliseconds. Defaults to 10000 (10s).

var simplemde = new SimpleMDE({
	element: document.getElementById("MyID"),
	status: false,
	status: ['autosave', 'lines', 'words', 'cursor'], // Optional usage
	toolbar: false,
	autofocus: true,
	lineWrapping: false,
	indentWithTabs: false,
	tabSize: 4,
	autosave: {
		enabled: true,
		unique_id: "MyUniqueID",
		delay: 1000,
	},
});

To change the minimum height (before it starts auto-growing):

.CodeMirror {
	min-height: 300px;
}

Or, you can keep the height static:

.CodeMirror {
	height: 300px;
}

Event handling

You can catch the following list of events: https://codemirror.net/doc/manual.html#events

var simplemde = new SimpleMDE();
simplemde.codemirror.on("change", function(){
	console.log(simplemde.value());
});

How it works

SimpleMDE is an improvement of lepture's Editor project and includes a great many number of changes. It is bundled with CodeMirror and depends on Font Awesome.

CodeMirror is the backbone of the project and parses much of the markdown syntax as it's being written. This allows us to add styles to the markdown that's being written. Additionally, a toolbar and status bar have been added to the top and bottom, respectively. Previews are rendered by Marked.

What's changed?

As mentioned earlier, SimpleMDE is an improvement of lepture's Editor project. So you might be wondering, what's changed? Quite a bit actually. Here's some notable changes:

Upgraded from CodeMirror 3 to CodeMirror 5
Many changes to the style, appearance, and userfriendliness
Interface more closely resembles Bootstrap
Now mobile friendly
Option to autosave the text as you type
The text editor now automatically grows as you type more
Fixed a large amount of bugs
Switched to Font Awesome icons
Improved preview rendering in many ways
Improved as-you-type appearance of headers and code blocks
Simplified the toolbar
Many new options during instantiation

praveenpuglia/Mendel