/* In-browser code editing made bearable */
CodeMirror is a JavaScript component that provides a code editor in the browser. When a mode is available for the language you are coding in, it will color your code, and optionally help with indentation.
A rich programming API and a CSS theming system are available for customizing CodeMirror to fit your application, and extending it with new functionality.
All of CodeMirror is released under a MIT-style license. To get it, you can download the latest release or the current development snapshot as zip files. To create a custom minified script file, you can use the compression API.
We use git for version control. The main repository can be fetched in this way:
git clone http://marijnhaverbeke.nl/git/codemirror
CodeMirror can also be found on GitHub at marijnh/CodeMirror. If you plan to hack on the code and contribute patches, the best way to do it is to create a GitHub fork, and send pull requests.
The manual is your first stop for learning how to use this library. It starts with a quick explanation of how to use the editor, and then describes the API in detail.
For those who want to learn more about the code, there is a series of posts on CodeMirror on my blog, and the old overview of the editor internals. The source code itself is, for the most part, also very readable.
Community discussion, questions, and informal bug reporting is done on the CodeMirror Google group. There is a separate group, CodeMirror-announce, which is lower-volume, and is only used for major announcements—new versions and such. These will be cross-posted to both groups, so you don't need to subscribe to both.
Though bug reports through e-mail are responded to, the preferred way to report bugs is to use the GitHub issue tracker. Before reporting a bug, read these pointers. Also, the issue tracker is for bugs, not requests for help.
When none of these seem fitting, you can simply e-mail the maintainer directly.
The following desktop browsers are able to run CodeMirror:
<!doctype
html>
is recommended.)I am not actively testing against every new browser release, and vendors have a habit of introducing bugs all the time, so I am relying on the community to tell me when something breaks. See here for information on how to contact me.
Mobile browsers mostly kind of work, but, because of limitations and their fundamentally different UI assumptions, show a lot of quirks that are hard to work around.
CodeMirror is developed and maintained by me, Marijn Haverbeke, in my own time. If your company is getting value out of CodeMirror, please consider purchasing a support contract.
CodeMirror support contracts exist in two forms—basic at €100 per month, and premium at €500 per month. Contact me for further information.
20-05-2013: Version 3.13:
cursorScrollMargin
and coverGutterNextToScrollbar
.19-04-2013: Version 3.12:
maxHighlightLength
and historyEventDelay
.addToHistory
option for markText
.20-03-2013: Version 3.11:
collapserange
,
formatting
, and simple-hint
addons. plsql
and mysql
modes
(use sql
mode).continuecomment
addon now exposes an option, rather than a command.placeholder
, HTML completion.hasFocus
, defaultCharWidth
.beforeCursorEnter
, renderLine
.show-hint
completion
dialog addon.21-02-2013: Version 3.1:
CodeMirror.Pass
to signal they
didn't handle the key.simple-hint.js
.insertLeft
option
to setBookmark
.eachLine
method to iterate over a document."beforeChange"
and "beforeSelectionChange"
events."hide"
and "unhide"
events to marked ranges.coordsChar
's
interpretation of its argument to match the documentation.25-01-2013: Version 3.02:
Single-bugfix release. Fixes a problem that prevents CodeMirror instances from being garbage-collected after they become unused.
21-01-2013: Version 3.01:
/addon
. You might have to adjust your
paths.rtlMoveVisually
option.showIfHidden
option for line widgets.fixedGutter
option.21-01-2013: Version 2.38:
Integrate some bugfixes, enhancements to the vim keymap, and new modes (D, Sass, APL) from the v3 branch.
20-12-2012: Version 2.37:
10-12-2012: Version 3.0:
New major version. Only partially backwards-compatible. See the upgrading guide for more information. Changes since release candidate 2:
20-11-2012: Version 3.0, release candidate 2:
addKeyMap
and removeKeyMap
methods.formatting
and closetag
add-ons.20-11-2012: Version 2.36:
scrollIntoView
public.defaultTextHeight
method.