Tools/Notes
1
0
Fork 0
mirror of https://github.com/TriliumNext/Notes.git synced 2025-08-10 18:39:22 +08:00
Code Issues Packages Projects Releases Wiki Activity

client: Add Javadoc for newly introduced methods

Browse Source
This commit is contained in:
Elian Doran 2024-10-27 11:32:54 +02:00
parent 3a609d54ab
commit a3932376f3
No known key found for this signature in database
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/public/app/services/mime_types.js
View File

@ -183,6 +183,14 @@ function getMimeTypes() {
let mimeToHighlightJsMapping = null; let mimeToHighlightJsMapping = null;
/**
* Obtains the corresponding language tag for highlight.js for a given MIME type.
*
* The mapping is built the first time this method is built and then the results are cached for better performance.
*
* @param {string} mimeType The MIME type of the code block, in the CKEditor-normalized format (e.g. `text-c-src` instead of `text/c-src`).
* @returns the corresponding highlight.js tag, for example `c` for `text-c-src`.
*/
function getHighlightJsNameForMime(mimeType) { function getHighlightJsNameForMime(mimeType) {
if (!mimeToHighlightJsMapping) { if (!mimeToHighlightJsMapping) {
const mimeTypes = getMimeTypes(); const mimeTypes = getMimeTypes();
@ -197,6 +205,13 @@ function getHighlightJsNameForMime(mimeType) {
return mimeToHighlightJsMapping[mimeType]; return mimeToHighlightJsMapping[mimeType];
} }
/**
* Given a MIME type in the usual format (e.g. `text/csrc`), it returns a MIME type that can be passed down to the CKEditor
* code plugin.
*
* @param {string} mimeType The MIME type to normalize, in the usual format (e.g. `text/c-src`).
* @returns the normalized MIME type (e.g. `text-c-src`).
*/
function normalizeMimeTypeForCKEditor(mimeType) { function normalizeMimeTypeForCKEditor(mimeType) {
return mimeType.toLowerCase() return mimeType.toLowerCase()
.replace(/[\W_]+/g,"-"); .replace(/[\W_]+/g,"-");