首页
/ EnlighterJS:开源语法高亮神器,让你的代码更出彩

EnlighterJS:开源语法高亮神器,让你的代码更出彩

2024-09-16 00:49:59作者:申梦珏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 开源协议,用户可以自由使用和修改。

快速开始

  1. 下载最新的 EnlighterJS 发布版本
  2. dist/ 目录中的文件复制到你的公共 HTML 目录。
  3. 在页面中引入 CSS 和 JS 文件。
  4. 使用 data-enlighter-language 属性标记你想要高亮的代码块。
  5. 初始化高亮功能。

最小示例

以下是一个最小化的示例,展示了如何使用 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 集成到你的项目中,享受代码高亮带来的视觉盛宴。快来试试吧!

登录后查看全文
热门项目推荐

热门内容推荐

最新内容推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
136
1.89 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
71
63
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.28 K
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
918
551
PaddleOCRPaddleOCR
飞桨多语言OCR工具包(实用超轻量OCR系统,支持80+种语言识别,提供数据标注与合成工具,支持服务器、移动端、嵌入式及IoT设备端的训练与部署) Awesome multilingual OCR toolkits based on PaddlePaddle (practical ultra lightweight OCR system, support 80+ languages recognition, provide data annotation and synthesis tools, support training and deployment among server, mobile, embedded and IoT devices)
Python
46
1
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
193
273
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
59
16