|
0
|
1 # CodeMirror 5
|
|
|
2
|
|
|
3 **NOTE:** [CodeMirror 6](https://codemirror.net/) exists, and is more mobile-friendly, more accessible, better designed, and much more actively maintained.
|
|
|
4
|
|
|
5 [](https://github.com/codemirror/codemirror5/actions)
|
|
|
6
|
|
|
7 CodeMirror is a versatile text editor implemented in JavaScript for
|
|
|
8 the browser. It is specialized for editing code, and comes with over
|
|
|
9 100 language modes and various addons that implement more advanced
|
|
|
10 editing functionality. Every language comes with fully-featured code
|
|
|
11 and syntax highlighting to help with reading and editing complex code.
|
|
|
12
|
|
|
13 A rich programming API and a CSS theming system are available for
|
|
|
14 customizing CodeMirror to fit your application, and extending it with
|
|
|
15 new functionality.
|
|
|
16
|
|
|
17 You can find more information (and the
|
|
|
18 [manual](https://codemirror.net/5/doc/manual.html)) on the [project
|
|
|
19 page](https://codemirror.net/5/). For questions and discussion, use the
|
|
|
20 [discussion forum](https://discuss.codemirror.net/).
|
|
|
21
|
|
|
22 See
|
|
|
23 [CONTRIBUTING.md](https://github.com/codemirror/CodeMirror/blob/master/CONTRIBUTING.md)
|
|
|
24 for contributing guidelines.
|
|
|
25
|
|
|
26 The CodeMirror community aims to be welcoming to everybody. We use the
|
|
|
27 [Contributor Covenant
|
|
|
28 (1.1)](http://contributor-covenant.org/version/1/1/0/) as our code of
|
|
|
29 conduct.
|
|
|
30
|
|
|
31 ### Installation
|
|
|
32
|
|
|
33 Either get the [zip file](https://codemirror.net/5/codemirror.zip) with
|
|
|
34 the latest version, or make sure you have [Node](https://nodejs.org/)
|
|
|
35 installed and run:
|
|
|
36
|
|
|
37 npm install codemirror@5
|
|
|
38
|
|
|
39 **NOTE**: This is the source repository for the library, and not the
|
|
|
40 distribution channel. Cloning it is not the recommended way to install
|
|
|
41 the library, and will in fact not work unless you also run the build
|
|
|
42 step.
|
|
|
43
|
|
|
44 ### Quickstart
|
|
|
45
|
|
|
46 To build the project, make sure you have Node.js installed (at least version 6)
|
|
|
47 and then `npm install`. To run, just open `index.html` in your
|
|
|
48 browser (you don't need to run a webserver). Run the tests with `npm test`.
|
