EnlighterJS:开源语法高亮神器,让你的代码更出彩
2024-09-16 10:24:08作者:申梦珏Efrain
项目介绍
EnlighterJS 是一款开源的语法高亮工具,完全基于纯 JavaScript 编写。它能够轻松地将你的代码片段转换为美观、易读的格式,提升文档和博客的专业度。EnlighterJS 的设计理念是简单易用,只需在网页中添加一个脚本和一个样式表,选择你想要高亮的元素,EnlighterJS 就会自动完成剩下的工作。
项目技术分析
EnlighterJS 的技术架构非常先进,具有以下核心技术特点:
- 零依赖:EnlighterJS 是一个独立的库,不需要依赖其他框架如 MooTools 或 jQuery,这使得它的集成更加简单和轻量。
- 高性能:采用了基于优先级正则表达式的超快分词引擎和第二阶段分词器,确保了高亮处理的效率。
- 可定制主题:主题完全可定制,使用 Less 编写,并且可以作为单独的 CSS 文件使用,减少了资源占用。
- 现代构建工具:使用 Gulp 进行构建,ES6 代码通过 Babel 转译,并使用 Rollup.js 进行打包。
项目及技术应用场景
EnlighterJS 适用于多种场景,包括但不限于:
- 技术博客:在博客中展示代码片段,提升阅读体验。
- 文档编写:在技术文档中高亮代码,使文档更加清晰易懂。
- 在线教程:在教程中展示代码,帮助学习者更好地理解。
- 代码分享平台:在代码分享网站中使用,提升代码展示的专业度。
项目特点
EnlighterJS 具有以下显著特点:
- 多语言支持:支持 40 多种编程语言和格式,涵盖了几乎所有主流编程语言。
- 多主题选择:提供 12 种高质量主题,满足不同用户的审美需求。
- 轻量级:极小的资源占用,JS 文件仅 45KB,CSS 文件仅 10KB。
- 易用性:只需几行代码即可完成初始化,适合各种技术水平的用户。
- 开源免费:基于 Mozilla Public License 2.0 开源协议,用户可以自由使用和修改。
快速开始
- 下载最新的 EnlighterJS 发布版本。
- 将
dist/
目录中的文件复制到你的公共 HTML 目录。 - 在页面中引入 CSS 和 JS 文件。
- 使用
data-enlighter-language
属性标记你想要高亮的代码块。 - 初始化高亮功能。
最小示例
以下是一个最小化的示例,展示了如何使用 EnlighterJS 高亮代码:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>EnlighterJS Test</title>
<!-- EnlighterJS Resources !-->
<link rel="stylesheet" href="enlighterjs.min.css" />
</head>
<body>
<main>
<p>Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore
et dolore <code>window.addEvent('domready', async (a,b) => {});</code> magna aliquyam erat.
</p>
<!-- Code to hghlight !-->
<pre data-enlighter-language="less">
// buttons used in codegroups + toolbar
.enlighter-btn{
display: inline-block;
margin: 0px 5px 0px 5px;
padding: 3px 5px 3px 5px;
border: solid 1px #333333;
background-color: #f0f0f0;
cursor: pointer;
}
// buttons
.enlighter-btn-raw{
background-image: data-uri('icons/enlighter_code.svg');
}
.enlighter-btn-window{
background-image: data-uri('icons/enlighter_rawcode.svg');
}
.enlighter-btn-website{
background-image: data-uri('icons/enlighter_icon_white.svg');
}
</pre>
</main>
<script type="text/javascript" src="enlighterjs.min.js"></script>
<script type="text/javascript">
// INIT CODE - simple page-wide initialization based on css selectors
// - highlight all pre + code tags (CSS3 selectors)
// - use javascript as default language
// - use theme "enlighter" as default theme
// - replace tabs with 2 spaces
EnlighterJS.init('pre', 'code', {
language : 'javascript',
theme: 'enlighter',
indent : 2
});
</script>
</body>
</html>
通过以上步骤,你就可以轻松地将 EnlighterJS 集成到你的项目中,享受代码高亮带来的视觉盛宴。快来试试吧!
热门项目推荐
相关项目推荐
- 国产编程语言蓝皮书《国产编程语言蓝皮书》-编委会工作区017
- nuttxApache NuttX is a mature, real-time embedded operating system (RTOS).C00
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTSX027
- 每日精选项目🔥🔥 01.17日推荐:一个开源电子商务平台,模块化和 API 优先🔥🔥 每日推荐行业内最新、增长最快的项目,快速了解行业最新热门项目动态~~026
- Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。Cangjie045
- 毕方Talon工具本工具是一个端到端的工具,用于项目的生成IR并自动进行缺陷检测。Python039
- PDFMathTranslatePDF scientific paper translation with preserved formats - 基于 AI 完整保留排版的 PDF 文档全文双语翻译,支持 Google/DeepL/Ollama/OpenAI 等服务,提供 CLI/GUI/DockerPython05
- mybatis-plusmybatis 增强工具包,简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.comJava03
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript0108
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript09
热门内容推荐
最新内容推荐
项目优选
收起
Python-100-Days
Python - 100天从新手到大师
Python
266
55
国产编程语言蓝皮书
《国产编程语言蓝皮书》-编委会工作区
65
17
Cangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
196
45
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
53
44
HarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
268
69
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
333
27
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
896
0
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
419
108
MateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。
官网地址:https://matechat.gitcode.com
144
24
HarmonyOS-Cangjie-Cases
参考 HarmonyOS-Cases/Cases,提供仓颉开发鸿蒙 NEXT 应用的案例集
Cangjie
58
4