https://github.com/mhuebert/bylight

Highlight code using special links in nearby text
https://github.com/mhuebert/bylight

documentation

Last synced: 3 months ago
JSON representation

Highlight code using special links in nearby text

• Host: GitHub
• URL: https://github.com/mhuebert/bylight
• Owner: mhuebert
• License: mit
• Created: 2024-08-26T23:57:42.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-28T20:32:54.000Z (almost 2 years ago)
• Last Synced: 2025-03-11T09:13:50.276Z (over 1 year ago)
• Topics: documentation
• Language: TypeScript
• Homepage: https://mhuebert.github.io/bylight/
• Size: 224 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Bylight

[![npm version](https://img.shields.io/npm/v/bylight.svg)](https://www.npmjs.com/package/bylight)

[![Test Status](https://github.com/mhuebert/bylight/workflows/Run%20Tests/badge.svg)](https://github.com/mhuebert/bylight/actions)

Bylight allows you to highlight code using special links in nearby text, making technical concepts more tangible when explaining code. See the [documentation and examples](https://mhuebert.github.io/bylight/).

![Example of Bylight in action](example.png)

## Features

- Highlight code snippets using special `bylight:` links

- Support for multiple highlighting patterns

- Regex pattern matching

- Directional highlighting (target specific code blocks)

- Customizable color scheme

- Easy integration with various JavaScript environments