codemirror5 README

The project's README from github.com/codemirror/codemirror5. As one markdown file: README.md.

This repository has moved to https://code.haverbeke.berlin/codemirror/codemirror5

CodeMirror 5

NOTE: CodeMirror 6 exists, and is more mobile-friendly, more accessible, better designed, and much more actively maintained.

CodeMirror is a versatile text editor implemented in JavaScript for the browser. It is specialized for editing code, and comes with over 100 language modes and various addons that implement more advanced editing functionality. Every language comes with fully-featured code and syntax highlighting to help with reading and editing complex code.

A rich programming API and a CSS theming system are available for customizing CodeMirror to fit your application, and extending it with new functionality.

You can find more information (and the manual) on the project page. For questions and discussion, use the discussion forum.

See CONTRIBUTING.md for contributing guidelines.

The CodeMirror community aims to be welcoming to everybody. We use the Contributor Covenant (1.1) as our code of conduct.

Installation

Either get the zip file with the latest version, or make sure you have Node installed and run:

npm install codemirror@5

NOTE: This is the source repository for the library, and not the distribution channel. Cloning it is not the recommended way to install the library, and will in fact not work unless you also run the build step.

Quickstart

To build the project, make sure you have Node.js installed (at least version 6) and then npm install. To run, just open index.html in your browser (you don't need to run a webserver). Run the tests with npm test.

codemirror5 (codemirror/codemirror5)

archive
Searching Database…

27.2K ·GitHub
archived
What is this?CodeMirror 5 is an in-browser code editor written in JavaScript, built for editing code with syntax highlighting and a rich API. This repo is the legacy version 5, now archived in favor of CodeMirror 6.
Is this a standalone app or a library I embed in my own page?It's a JavaScript library you embed into a web page; it provides a programming API and CSS theming system rather than being a standalone application.
How do I add it to my project?Install via npm with 'npm install codemirror@5', or download the zip with the latest release. Cloning the source repo directly won't work without running the build step.
Should I actually use this for a new project?No — this repo has moved/archived, and the README itself recommends CodeMirror 6 instead, calling it more mobile-friendly, more accessible, better designed, and more actively maintained.
Who still needs this version instead of CodeMirror 6?Mainly developers maintaining existing projects already built on CodeMirror 5, or needing one of its 100+ legacy language modes/addons not yet ported.
Does it work in any browser without a server?Yes, it runs entirely client-side in the browser; to try the quickstart you can just open index.html locally without running a web server.
How many language modes does it support out of the box?CodeMirror 5 ships with over 100 language modes plus various addons for advanced editing features like code folding and autocompletion.
Can I customize the editor's look?Yes, it comes with a CSS theming system and a rich programming API so you can style and extend it to fit your application.
How do I run the test suite?After installing dependencies with npm, run 'npm test' to execute the project's test suite.
Why is this repo archived?The maintainers moved development to CodeMirror 6, which they consider more mobile-friendly, accessible, and actively maintained, so version 5 is kept only for legacy use.
What are similar projects?ace, editor.md, draft-js, jsoneditor, pell, trix, tui.editor, Sortable
Creator
codemirror
Size
19.1 MB
Stars
27.2K
Age
15y
Commits · 90 Days