Discource-C/discourse
1
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-02-07 03:48:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

FEATURE: allow custom HighlightJS languages

Browse Source 
Adds pluginApi function that allows themes and plugins to register languages for HighlightJS.
This commit is contained in:
Penar Musaraj 2019-01-02 19:07:36 -05:00
parent 4af7471ead
commit a953b71797
2 changed files with 36 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
app/assets/javascripts/discourse/lib/highlight-syntax.js.es6
View File

@ -1,4 +1,5 @@
/*global hljs:true */
let _moreLanguages = [];
import loadScript from "discourse/lib/load-script";
@ -14,6 +15,21 @@ export default function highlightSyntax($elem) {
$(selector, $elem).each(function(i, e) {
$(e).removeClass("lang-auto");
loadScript(path).then(() => hljs.highlightBlock(e));
loadScript(path).then(() => {
customHighlightJSLanguages();
hljs.highlightBlock(e);
});
});
}
export function registerHighlightJSLanguage(name, fn) {
_moreLanguages.push({ name: name, fn: fn });
}
function customHighlightJSLanguages() {
_moreLanguages.forEach(l => {
if (hljs.getLanguage(l.name) === undefined) {
hljs.registerLanguage(l.name, l.fn);
}
});
}

20
app/assets/javascripts/discourse/lib/plugin-api.js.es6
View File

@ -4,6 +4,7 @@ import ComposerEditor from "discourse/components/composer-editor";
import DiscourseBanner from "discourse/components/discourse-banner";
import { addButton } from "discourse/widgets/post-menu";
import { includeAttributes } from "discourse/lib/transform-post";
import { registerHighlightJSLanguage } from "discourse/lib/highlight-syntax";
import { addToolbarCallback } from "discourse/components/d-editor";
import { addWidgetCleanCallback } from "discourse/components/mount-widget";
import {
@ -40,7 +41,7 @@ import Sharing from "discourse/lib/sharing";
import { addComposerUploadHandler } from "discourse/components/composer-editor";
// If you add any methods to the API ensure you bump up this number
const PLUGIN_API_VERSION = "0.8.26";
const PLUGIN_API_VERSION = "0.8.27";
class PluginApi {
constructor(version, container) {
@ -790,6 +791,23 @@ class PluginApi {
replaceCategoryLinkRenderer(fn) {
replaceCategoryLinkRenderer(fn);
}
/**
* Registers custom languages for use with HighlightJS.
*
* See https://highlightjs.readthedocs.io/en/latest/language-guide.html
* for instructions on how to define a new language for HighlightJS.
* Build minified language file by running "node tools/build.js -t cdn" in the HighlightJS repo
* and use the minified output as the registering function.
*
* Example:
*
* let aLang = function(e){return{cI:!1,c:[{bK:"GET HEAD PUT POST DELETE PATCH",e:"$",c:[{cN:"title",b:"/?.+"}]},{b:"^{$",e:"^}$",sL:"json"}]}}
* api.registerHighlightJSLanguage("kibana", aLang);
**/
registerHighlightJSLanguage(name, fn) {
registerHighlightJSLanguage(name, fn);
}
}
let _pluginv01;