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

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 开源协议,用户可以自由使用和修改。

快速开始

  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 集成到你的项目中,享受代码高亮带来的视觉盛宴。快来试试吧!

热门项目推荐
相关项目推荐

项目优选

收起
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
33
24
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
830
0
redis-sdkredis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
376
32
advanced-javaadvanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.92 K
19.09 K
qwerty-learnerqwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.62 K
1.45 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
19
2
杨帆测试平台杨帆测试平台
扬帆测试平台是一款高效、可靠的自动化测试平台,旨在帮助团队提升测试效率、降低测试成本。该平台包括用例管理、定时任务、执行记录等功能模块,支持多种类型的测试用例,目前支持API(http和grpc协议)、性能、CI调用等功能,并且可定制化,灵活满足不同场景的需求。 其中,支持批量执行、并发执行等高级功能。通过用例设置,可以设置用例的基本信息、运行配置、环境变量等,灵活控制用例的执行。
JavaScript
9
1
Yi-CoderYi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
57
7
RuoYi-VueRuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
147
26
anqicmsanqicms
AnQiCMS 是一款基于Go语言开发,具备高安全性、高性能和易扩展性的企业级内容管理系统。它支持多站点、多语言管理,能够满足全球化跨境运营需求。AnQiCMS 提供灵活的内容发布和模板管理功能,同时,系统内置丰富的利于SEO操作的功能,帮助企业简化运营和内容管理流程。AnQiCMS 将成为您建站的理想选择,在不断变化的市场中保持竞争力。
Go
78
5