Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/DavG25/text-generation-webui-code_syntax_highlight
An extension for oobabooga's text-generation-webui that adds syntax highlighting to code snippets
https://github.com/DavG25/text-generation-webui-code_syntax_highlight
Last synced: 2 months ago
JSON representation
An extension for oobabooga's text-generation-webui that adds syntax highlighting to code snippets
- Host: GitHub
- URL: https://github.com/DavG25/text-generation-webui-code_syntax_highlight
- Owner: DavG25
- Created: 2023-04-24T00:46:12.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-08T20:31:02.000Z (6 months ago)
- Last Synced: 2024-05-09T19:29:45.623Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 161 KB
- Stars: 61
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Code Syntax Highlight
### An extension for [oobabooga's text-generation-webui](https://github.com/oobabooga/text-generation-webui/) to highlight code snippets
> [!NOTE]
> Versions of text-generation-webui released after the 26th of April 2024 support syntax highlighting of code snippets by default without needing this extension
## Features
- Uses highlight.js with the [GitHub theme](https://highlightjs.org/demo#lang=python&v=1&theme=github-dark&code=ZGVmIGNyZWF0ZV9pbnRlcmZhY2UoKToKCiAgICB0aXRsZSA9ICdUZXh0IGdlbmVyYXRpb24gd2ViIFVJJ8YmIyBQYXNzd29yZCBhdXRoZW50aWPFJ8UexBMgPSBbXcUOaWYgc2hhcmVkLmFyZ3MuZ3JhZGlvX8QkOsUgyDIuZXh0ZW5kKHguc3RyaXAoKSBmb3IgeCBpbthAxyknIicpLnJlcGzkAMgnXG4nLCAnJykuc3BsaXQoJywnKeQAg8lWKf8AlV9wYewAmndpdGggb3BlbijcMCwgJ3InLCBlbmNvZGluZz0idXRmOCIpIGFzIGZpbGXKT%2F4A7WxpbmXkAPDENOoA%2FsQW%2FgDO6AFxdHVwbGUoY%2BQAp8cwOicpxlvEFcRNxCtd6AHFSW1wb3J0IHRoZSDlAJBzaW9ucyBhbmQgZXhlY3V0ZcQbaXIgc2V0deUApHVuY%2BQB5nP0AUTLQmlzIG5vdCBOb25lxU5s7wE%2FyispID4gMOoBH8oZX21vZHVsZS5sb2FkX8oXKCk%3D)
- Supports [common](https://highlightjs.org/download/#:~:text=common) programming languages
- Can also highlight inline code snippets
- Provides an optional button in each code snippet to copy the code to the clipboard
- Works in all interface modes: default, notebook, and chat
- Automatically switches between light and dark themes to match the web UI theme
- Has a performance mode for minimal CPU usage
## Installation
The extension can be installed by cloning this repository inside the `../text-generation-webui/extensions` folder:
```
cd text-generation-webui/extensions
```
```
git clone https://github.com/DavG25/text-generation-webui-code_syntax_highlight code_syntax_highlight
```
It's also possible to install the extension by directly downloading the latest version from the [releases page](https://github.com/DavG25/text-generation-webui-code_syntax_highlight/releases/latest) and extracting the ZIP archive inside the `../text-generation-webui/extensions` folder
## Updates
To check for updates, simply compare the currently installed extension version in the web UI with the latest available version in the [releases page](https://github.com/DavG25/text-generation-webui-code_syntax_highlight/releases/latest)
If the available version is higher than the installed one, run the following command:
```
cd text-generation-webui/extensions
```
```
git pull
```
If the extension was installed by downloading the ZIP archive, delete the currently installed version in the `../text-generation-webui/extensions` folder and extract the new version ZIP archive in the same location
## Configuration and persistent settings
The extension can be enabled directly in the `Interface mode` tab inside the web UI once installed
To automatically load the extension when starting the web UI, either specify it in the `--extensions` [command-line flag](https://github.com/oobabooga/text-generation-webui#basic-settings) or add it in the `settings.yaml` file in the `../text-generation-webui` folder:
```yaml
default_extensions:
- code_syntax_highlight
```
For settings to persist over web UI restarts and reloads, add the following lines to the `settings.yaml` file:
```yaml
code_syntax_highlight-activate: true
code_syntax_highlight-inline_highlight: false
code_syntax_highlight-copy_button: false
code_syntax_highlight-performance_mode: true
```
Change the values (`true` / `false`) according to the preferred settings