JavaScript library to highlight text, math and/or code

[Kreijstal]

Project description

The following image was made with Latex which shows roughly how the webpage should be shown

This is useful in education where one wants to highlight specific elements in order to explain their function, and makes it easier to see how things connect or the name of the parts composing the whole.

There can be arrows pointing to information that is considered important, with some text to clarify something.

Complexity

• [ ] Beginner - This project requires no or little prior knowledge of the technolog(y|ies) specified to contribute to the project
• [x] Intermediate - The user should have some prior knowledge of the technolog(y|ies) to the point where they know how to use it, but not necessarily all the nooks and crannies of the technology
• [ ] Advanced - The project requires the user to have a good understanding of all components of the project to contribute

Required time (ETA)

• [ ] Little work - A couple of days
• [ ] Medium work - A week or two
• [x] Much work - The project will take more than a couple of weeks and serious planning is required

[slavaGanzin]

https://stackoverflow.com/questions/8644428/how-to-highlight-text-using-javascript

[kiocos]

@Kreijstal How would you like to be able to use it? Can you give an example of a possible workflow using such library?

[Kreijstal]

@kiocosta Hmm, if what you're asking is for an API design, I think of the following:

//selector is maybe a css selector or 
highlight(selector)
tooltip(selector,"This is a tooltip that points to the highligted text")

Probably shouldn't be overly complicated, just a dumb library that simply highlights and optionally "tooltips" an element