https://github.com/bigbluebutton/plugin-code-highlight
https://github.com/bigbluebutton/plugin-code-highlight
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bigbluebutton/plugin-code-highlight
- Owner: bigbluebutton
- License: lgpl-3.0
- Created: 2024-06-10T17:07:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T20:50:56.000Z (over 1 year ago)
- Last Synced: 2024-11-26T22:34:22.783Z (over 1 year ago)
- Language: TypeScript
- Size: 430 KB
- Stars: 2
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Code Highlighter Plugin
## What is it?
The Code Highlighter Plugin serves as a chat tool for studenteds and users to demonstrate and compreehend code blocks in simpler, more visual ways.
## Building the Plugin
To build the plugin for production use, follow these steps:
```bash
cd $HOME/src/plugin-code-highlight
npm ci
npm run build-bundle
```
The above command will generate the `dist` folder, containing the bundled JavaScript file named `CodeHighlighter.js`. This file can be hosted on any HTTPS server along with its `manifest.json`.
If you install the Plugin separated to the manifest, remember to change the `javascriptEntrypointUrl` in the `manifest.json` to the correct endpoint.
To use the plugin in BigBlueButton, send this parameter along in create call:
```
pluginManifests=[{"url":"/path/to/manifest.json"}]
```
Or additionally, you can add this same configuration in the `.properties` file from `bbb-web` in `/usr/share/bbb-web/WEB-INF/classes/bigbluebutton.properties`
## Development mode
As for development mode (running this plugin from source), please, refer back to https://github.com/bigbluebutton/bigbluebutton-html-plugin-sdk section `Running the Plugin from Source`