【亲测免费】 CodeMirror 5 项目教程

2026-01-16 10:06:42作者：滑思眉Philip

1. 项目的目录结构及介绍

CodeMirror 5 项目的目录结构如下：

codemirror5/
├── addon/
├── bin/
├── demo/
├── doc/
├── keymap/
├── lib/
├── mode/
├── src/
├── test/
├── theme/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .npmignore
├── AUTHORS
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── index.html
├── package.json
└── rollup.config.js

目录介绍

addon/: 包含各种扩展功能的插件。
bin/: 包含一些命令行工具。
demo/: 包含各种演示示例。
doc/: 包含项目的文档。
keymap/: 包含不同的键盘映射配置。
lib/: 包含核心的 JavaScript 文件。
mode/: 包含各种编程语言的语法高亮模式。
src/: 包含源代码文件。
test/: 包含测试文件。
theme/: 包含不同的主题样式。
.editorconfig, .gitattributes, .gitignore, .npmignore: 配置文件。
AUTHORS, CHANGELOG.md, CONTRIBUTING.md, LICENSE, README.md: 项目文档和许可证。
index.html: 项目的启动文件。
package.json: 项目的配置文件。
rollup.config.js: Rollup 构建配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.html。这个文件包含了基本的 HTML 结构和引入 CodeMirror 的脚本，用于在浏览器中启动和展示 CodeMirror 编辑器。

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>CodeMirror 5</title>
  <link rel="stylesheet" href="lib/codemirror.css">
  <script src="lib/codemirror.js"></script>
  <script src="mode/javascript/javascript.js"></script>
</head>
<body>
  <textarea id="code" name="code">console.log("Hello, World!");</textarea>
  <script>
    var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
      lineNumbers: true,
      mode: "javascript"
    });
  </script>
</body>
</html>

启动文件说明

<link rel="stylesheet" href="lib/codemirror.css">: 引入 CodeMirror 的 CSS 样式文件。
<script src="lib/codemirror.js"></script>: 引入 CodeMirror 的核心 JavaScript 文件。
<script src="mode/javascript/javascript.js"></script>: 引入 JavaScript 语法高亮模式。
<textarea id="code" name="code">...</textarea>: 定义一个文本区域，用于初始化 CodeMirror 编辑器。
CodeMirror.fromTextArea(document.getElementById("code"), {...}): 初始化 CodeMirror 编辑器，并设置一些基本配置，如行号显示和语法模式。

3. 项目的配置文件介绍

项目的配置文件主要是 package.json 和 rollup.config.js。

package.json

package.json 文件包含了项目的元数据和依赖项信息，以及一些脚本命令。

{
  "name": "codemirror5",
  "version": "5.65.0",
  "description": "In-browser code editor (version 5 legacy)",
  "main": "lib/codemirror.js",
  "scripts": {
    "test": "node ./test/run.js",
    "build": "rollup -c rollup.config.js"
  },
  "dependencies": {
    "codemirror": "^5.65.0"
  },
  "devDependencies": {
    "rollup": "^2.0.0"
  }
}