/mark-react

Mark react is a search highlighter that can search a page and mark or (highlight) the searched result it was inspired by mark.js

Primary LanguageTypeScriptMIT LicenseMIT

Mark-React

Table of content

Description

Mark-React is an open source project inspired by mark.js that is a term highlighter we decide to remove the jquery part although mark.js has vanilla js part too we decided to make a component that is using react api with a ui that is kinda similar to the ctrl + f of browser

Usage

yarn add mark-react
npm i mark-react
pnpm i mark-react

Contribute

To contribute and add your favorite feature or fix a bug you have to fork the project and then create a branch with name of your feature or fix-bug then write test for it after you have been develop it and test it you can do a merge request

yarn install
#or
npm install
git checkout -b feature-branch

start dev server

yarn dev

test it is in --watch mode

yarn test

Know you can develop the feature

maintained with ❤️ by Amir Hossein.