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