Skip to content

README.md

Latest commit

 

History

History
49 lines (33 loc) · 1.55 KB

README.md

File metadata and controls

49 lines (33 loc) · 1.55 KB

Bionic Reading for VS Code

Bionic Reading is a Visual Studio Code extension that emphasizes parts of words to enhance readability.

Features

  • Emphasizes Parts of Words: Boldens the first few characters of each word.
  • Configurable Settings: Customize the bolding percentage and enable/disable the extension.
  • Keyword Exclusions: Excludes common keywords, methods, and properties from bolding.
  • Handles Comments and Quotes: Excludes text within comments and quotes from bolding.

Installation

  1. Download the extension.
  2. Extract the extension to your .vscode/extensions directory.
  3. Reload VS Code to activate the extension.

Usage

Open a file in VS Code to see the Bionic Reading emphasis applied automatically.

Settings

Configure the extension via the settings UI or settings.json:

  • Percentage of Word to Bold (bionic-reading.percentageOfWord): Default is 0.5.
  • Enable/Disable Extension (bionic-reading.enabled): Default is true.

Example Settings in settings.json

{
    "bionic-reading.percentageOfWord": 0.5,
    "bionic-reading.enabled": true
}

Excluded Keywords Automatically excludes:

JavaScript/TypeScript reserved keywords (e.g., const, function, return, if, else, etc.) Common functions/methods (e.g., console.log, setTimeout, querySelector, forEach, includes, etc.) Common DOM properties (e.g., backgroundColor, href, src, classList, etc.) Contribution Contributions are welcome. Open issues, submit pull requests, or provide feedback.

License Licensed under the MIT License.