https://github.com/sleitnick/rbx-doc-search

Roblox Creator Docs search extension and data aggregation
https://github.com/sleitnick/rbx-doc-search

extension extension-chrome roblox search

Last synced: about 2 months ago
JSON representation

Roblox Creator Docs search extension and data aggregation

• Host: GitHub
• URL: https://github.com/sleitnick/rbx-doc-search
• Owner: Sleitnick
• License: mit
• Created: 2023-08-29T21:12:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-26T00:49:14.000Z (about 2 months ago)
• Last Synced: 2024-10-26T18:49:02.755Z (about 2 months ago)
• Topics: extension, extension-chrome, roblox, search
• Language: JavaScript
• Homepage: https://chromewebstore.google.com/detail/roblox-docs-search/mejgpalbcgoooijaoomkcmcjeihhlehf
• Size: 51.8 KB
• Stars: 6
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ![img](extension/icons/32.png) Roblox Creator Docs Search

This repository contains two parts:

1. Data aggregation in relation to the Roblox Creator Docs

2. Browser extension

## Data Aggregation

Data aggregation is automated through a daily workflow, which creates a release of the aggregated data. This process is done through the Python scripts in the `scripts` directory.

This process helps ensure that the extension is using up-to-date metadata for search.

A new release is created for each aggregation collected. If no changes were found since the last release, the release is skipped.

## Extension

Links:

- [Chrome & Edge](https://chromewebstore.google.com/detail/roblox-docs-search/mejgpalbcgoooijaoomkcmcjeihhlehf)

- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/roblox-docs-search/)

The extension code can be found in the `extension` and `src` directories. The `extension` directory contains the core extension code. The search algorithm has been moved over to WASM to speed up the process, which can be found in the `src` directory.

### WASM Compilation

To generate the WASM code, run the `build.sh` file. This will compile the code and output it within the relevant extension directory (`extension/popup/pkg`).

### Package Extension

Run the `package.sh` file to package the extension file.