当前位置:

首页 > 编程开发 > SyntaxHighlighter配合CKEditor插件轻松打造代码语法着色

SyntaxHighlighter配合CKEditor插件轻松打造代码语法着色

基于3.0.83版SyntaxHighlighter与3.5.3版CKEditor,整理了一套代码语法着色集成方案。在CKEditor中开发insertcode插件,通过配置config.js添加工具栏按钮,实现在页面中插入代码并高亮显示,支持多种编程语言,提升代码可读性。

本文目录

    在网上搜索相关教程,发现不少文章大同小异。很多开发者选择使用SyntaxHighlighter配合CKEditor插件来实现代码语法着色。不过由于版本差异,实际操作中可能会遇到一些问题。本文基于3.0.83版SyntaxHighlighter和3.5.3版CKEditor,整理了一套可行的集成方案,供参考。

    SyntaxHighlighter配合CKEditor插件轻松打造代码语法着色

    一、SyntaxHighlighter简介

    SyntaxHighlighter(原名:dp.SyntaxHighlighter)是一套在浏览器上对各种代码进行语法着色的Ja vaScript库。官方下载地址:http://alexgorbatchev.com/SyntaxHighlighter/。本文使用的版本是3.0.83版,下载后只需要syntaxhighlighter文件夹下的“scripts”和“styles”文件夹内的文件即可。

    在代码语法着色高亮显示的页面中,需要引用“styles/shCore.css”样式文件和“scripts/shCore.js”JS文件。由于每一种代码语言都要引用各自的JS文件,为了降低HTTP请求,可以把所有代码语言的JS文件内容合并到一个“scripts/shBrushSeaYee.js”文件里,并优化成一行。例如:

    复制代码

    代码如下:

    二、CKEditor简介

    CKEditor是一个专门使用在网页上的开源所见即所得文字编辑器。它追求轻量化,安装步骤简单,可和PHP、Ja vaScript、ASP、ASP.NET、ColdFusion、Ja va、ABAP等不同编程语言结合。它原名FCKEditor,2009年发布3.0版本后改名为CKEditor。原来叫FCK是因为最初的开发者叫Frederico Calderia Knabben;现在叫CK,意指“Content and Knowledge”。官方下载地址:http://ckeditor.com/。本文使用的版本是3.5.3版,安装配置都比较简单,不再赘述。

    三、CKEditor代码语法着色高亮显示的插件开发

    1、在“ckeditor\plugins\”目录下新建“insertcode”目录

    在“insertcode”目录下新建一个“plugin.js”,输入以下代码:

    复制代码

    代码如下:

    CKEDITOR.plugins.add('insertcode',

    {

    init: function(editor)

    {

    //plugin code goes here

    var pluginName = 'Insertcode';

    CKEDITOR.dialog.add(pluginName, this.path + 'insertcode.js');

    editor.config.flv_path = editor.config.flv_path || (this.path);

    editor.addCommand(pluginName, new CKEDITOR.dialogCommand(pluginName));

    editor.ui.addButton('Insertcode',

    {

    label: '代码',

    command: pluginName,

    icon: this.path + 'insertcode.gif'

    });

    }

    });

    注意:第1行代码中的“insertcode”必须与文件夹名称相同且区分大小写字母,因为在Linux系统的Web服务器中,路径区分大小写。

    2、放入图标文件

    在“insertcode”目录下放入一个“insertcode.gif”16×16的图片,可以自己制作或从网上查找。

    3、新建“insertcode.js”文件

    在“insertcode”目录下新建一个“insertcode.js”,输入如下代码:

    复制代码

    代码如下:

    CKEDITOR.dialog.add('Insertcode', function(editor){

    var escape = function(value){return value;};

    return{

    title: '代码',

    resizable: CKEDITOR.DIALOG_RESIZE_BOTH,

    minWidth: 720,

    minHeight: 520,

    contents: [{

    id: 'cb',

    name: 'cb',

    label: 'cb',

    title: 'cb',

    elements: [{

    type: 'select',

    label: 'Language',

    id: 'lang',

    required: true,

    'default': 'csharp',

    items: [['ActionScript3', 'as3'], ['Bash/shell', 'bash'], ['ColdFusion', 'cf'], ['C#', 'csharp'], ['C++', 'cpp'], ['CSS', 'css'], ['Delphi', 'delphi'], ['Diff', 'diff'], ['Groovy', 'groovy'], ['Ja vaScript', 'js'], ['Ja va', 'ja va'], ['Ja vaFX', 'jfx'], ['Perl', 'perl'], ['PHP', 'php'], ['Plain Text', 'plain'], ['PowerShell', 'ps'], ['Python', 'py'], ['Ruby', 'rails'], ['Scala', 'scala'], ['SQL', 'sql'], ['Visual Basic', 'vb'], ['XML', 'xml']]

    }, {

    type: 'textarea',

    style: 'width:718px;height:450px',

    label: 'Code',

    id: 'code',

    rows: 31,

    'default': ''

    }]

    }],

    onOk: function(){

    code = this.getValueOf('cb', 'code');

    lang = this.getValueOf('cb', 'lang');

    html = '' + escape(code) + '';

    editor.insertHtml("

    " + html + "
    ");

    },

    onLoad: function(){}

    };

    });

    4、配置CKEditor的config.js

    在“ckeditor\”目录下找到“config.js”文件,添加如下代码:

    复制代码

    代码如下:

    config.extraPlugins = 'insertcode';

    注意:代码中的“insertcode”也必须与文件夹名称相同,区分大小写字母。要在CKEditor工具栏添加按钮,就在此配置文件中添加上“,Insertcode”即可,同样注意大小写。至此,插件配置完成。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    ckeditor和ueditor那个好 CKEditor和UEditor使用比较
    ckeditor和ueditor那个好 CKEditor和UEditor使用比较

    CKEditor功能成熟但需自行编写较多逻辑;UEditor界面美观、开箱即用,但前后台交互较复杂,上传配置需注意路径前缀,还需处理Struts过滤器对静态请求的拦截问题。两者各有侧重,需根据项目需求选择。

    最新版CKEditor的配置方法及插件(Plugin)编写示例
    最新版CKEditor的配置方法及插件(Plugin)编写示例

    CKEditor是开源HTML编辑器,通过编辑config.js配置文件可自定义工具栏和字体大小。插件开发以分页插件为例:在插件目录plugins下创建名为apage的子文件夹,编写plugin.js实现对话框或直接插入分页符,需在配置中声明extraPlugins参数以加载该插件。

    ckeditor syntaxhighlighter代码高亮插件配置分享
    ckeditor syntaxhighlighter代码高亮插件配置分享

    通过整合SyntaxHighlighter插件,为CKEditor添加代码高亮功能。需下载编辑器与插件,创建insertcode插件并编写plugin.js与dialog.js,修改ckeditor.js配置以注册插件并添加工具栏按钮,最后在语言文件中添加映射。该方法支持多种编程语言代码的插入与高亮显示。

    CKEditor中加入syntaxhighlighter代码高亮插件
    CKEditor中加入syntaxhighlighter代码高亮插件

    在CKEditor3.3.1中集成SyntaxHighlighter需新建insertcode插件目录,包含plugin.js、对话框配置及图标;修改ckeditor.js添加插件引用,调整语言文件,在前端引入样式与脚本,完成插入代码高亮功能。

    dedecms ckeditor编辑器添加链接默认新窗口打开的修改方法
    dedecms ckeditor编辑器添加链接默认新窗口打开的修改方法

    用DEDECMS做网站的朋友,多半都遇到过这个小小的困扰:文章页里插入的链接,默认总是直接在当前窗口跳转,而不是在新标签页打开。去网上搜一下,找到的教程几乎全是针对老版FCKeditor的,而DEDECMS v5.7 默认搭载的已经是ckeditor编辑器了。这里简单记一下修改方法,希望能帮到同样被

    为SyntaxHighlighter添加新语言的方法
    为SyntaxHighlighter添加新语言的方法

    以Lua为例,获取shBrushLua.js,在WordPress插件目录新建文件夹,上传JS并创建同名PHP插件文件,激活即可扩展SyntaxHighlighter语言支持,独立插件避免升级丢失配置。

    ckeditor插件开发简单实例
    ckeditor插件开发简单实例

    具体步骤:在CKeditor中开发自定义插件,先创建插件文件夹并放置图标,然后编写plugin.js实现选中文字后自动插入一个带超链接的图标,最后修改config.js加载插件并配置工具栏按钮,即可在编辑器中使用该插件。

    PHP中CKEditor和CKFinder配置问题小结
    PHP中CKEditor和CKFinder配置问题小结

    在PHP中配置CKEditor和CKFinder时,需预设config.js的默认设置,使用PHP类生成编辑器,设置CKFinder的CheckAuthentication函数通过session验证,利用session定位上传路径,并采用日期重命名上传文件以防乱码,最后通过CKFinder::SetupCKEditor实现两者配合,提升安全性。

    ckeditor syntaxhighlighter代码高亮插件,完美修复
    ckeditor syntaxhighlighter代码高亮插件,完美修复

    针对CKeditor与FCKeditor对象模型差异,采用先插入新节点再删除原节点的方法修复代码高亮插件。高级配置新增“不自动转换超链接”选项,用户可自由控制代码中网址是否自动转为超链接,提升灵活性。

    当使用ckeditor控件时,需要校验输入内容是否为空的一种解决办法(转帖)
    当使用ckeditor控件时,需要校验输入内容是否为空的一种解决办法(转帖)

    CKEditor内容非空验证失效,因编辑器在表单提交后才更新隐藏域,验证脚本提前读取空值。解决方法:在验证函数中取消表单提交,利用setTimeout延迟50毫秒,待编辑器完成同步后再执行验证和提交。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。