Skip to content

Ragudos/bionic-reader

Repository files navigation

bionic-reader

A simple bionic-reader algorithm I implemented.

This is solely from what I, the programmer, have thought of with the help of ideas from articles and documentations, and you, the reader of this README file, can use this however you'd like.

how it's implemented

Based on what I read about the bionic algorithm and AI LLMs, it looks for big words like transition words to highlight more letters in those words, while skipping over small words like articles (i.e. "the", "an", "a"). But for now, I'm depending on Math.random() alongside a ratio. For example:

const bionify = new Bionify(0.5 /** The ratio */);
const bionifiedWords = bionify.transform("Hello");

/** Logs and array of object/s equal to:
 * 
 *  [{
 *    highlightedText: "He",
 *     unhighlightedText: "llo"
 *  }]
 *  
 *  This was acquired through the formula: 'Math.floor((word.length - 1) * this.ratio)'
 */
console.log(bionifiedWords);

notes when forking

Please note that I use pnpm as the package manager for this repository.

  git clone [link-to-your-fork]
  pnpm install
  pnpm run prepare

About

A simple bionic-reader algorithm I implemented.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published