mark.js

What is mark.js?

mark.js is a JavaScript library for highlighting text. It allows you to search for text within a web page and highlight it, making it useful for search functionality, text analysis, and more.

What are mark.js's main functionalities?

Basic Text Highlighting

This feature allows you to highlight specific text within a given context. In this example, the word 'highlight' will be highlighted within the element with the class 'context'.

const Mark = require('mark.js');
const context = document.querySelector('.context');
const instance = new Mark(context);
instance.mark('highlight');

Custom Highlighting Options

This feature allows you to customize the highlighting element and class. In this example, the word 'highlight' will be wrapped in a <span> element with the class 'custom-highlight'.

const Mark = require('mark.js');
const context = document.querySelector('.context');
const instance = new Mark(context);
instance.mark('highlight', {
  'element': 'span',
  'className': 'custom-highlight'
});

Unmarking Text

This feature allows you to remove all highlights within a given context. In this example, all highlights within the element with the class 'context' will be removed.

const Mark = require('mark.js');
const context = document.querySelector('.context');
const instance = new Mark(context);
instance.unmark();

Other packages similar to mark.js

highlight.js

highlight.js is a syntax highlighter written in JavaScript. It is used to highlight code syntax in web pages. Unlike mark.js, which is used for text highlighting, highlight.js is specifically designed for code syntax highlighting.

prismjs

Prism is a lightweight, extensible syntax highlighter. It is used to highlight code syntax in web pages. Similar to highlight.js, Prism is focused on code syntax highlighting rather than general text highlighting like mark.js.

text-highlighter

text-highlighter is a JavaScript library for highlighting text in web pages. It provides similar functionality to mark.js, allowing you to highlight text within a given context. However, it may not be as feature-rich or customizable as mark.js.

README

mark.js

:sparkles: formerly known as jquery.mark or jmHighlight :sparkles:

Highlight keywords using JavaScript. Intended for every use case.
Can e.g. be used to mark text in search results.

Documentation and Further Information

Please view the website for documentation and further information!

Contributing

See the contribution guidelines.

Changelog

Changes are documented in release descriptions.
You want to be notified about new releases? Click the "Subscribe to releases" button on libraries.io.

---

Happy hacking!