jsvine / jsvine/notebookjs

'<' and '>' gets escaped twice when used with Prismjs

Open
#30 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
298
Forks
44
PR merge metrics
No merged PRs in 30d

Description

I am trying to use the library along with Prism highlighting to render a notebook's content. It seems like the notebookjs library html-escapes the '<' and '>' characters before passing it to the highlighter. The highlighter treats it as the actual code and renders it as such by tokenising < and >

Anyway to disable escaping or any recommended way to handle this situation?

I am using the code given on the site to use prism highlighting. ie

`var Prism = require('prismjs');

var highlighter = function(code, lang) {
if (typeof lang === 'undefined') lang = 'markup';

if (!Prism.languages.hasOwnProperty(lang)) {
    try {
        require('prismjs/components/prism-' + lang + '.js');
    } catch (e) {
        console.warn('** failed to load Prism lang: ' + lang);
        Prism.languages[lang] = false;
    }
}
return Prism.languages[lang] ? Prism.highlight(code, Prism.languages[lang]) : code;

};
var nb = require("notebookjs");
nb.highlighter = function(text, pre, code, lang) {
var language = lang || 'text';
pre.className = 'language-' + language;
if (typeof code != 'undefined') {
code.className = 'language-' + language;
}
return highlighter(text, language);
};`

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a repository file or test; start with the nb.highlighter callback and the Prism.highlight call shown in the report. Reproduce the double escaping with the supplied integration, then verify that angle brackets are highlighted once rather than tokenised as < and >.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, web-dev
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.