You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

48 lines
2.0 KiB

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