jargonsdev / jargonsdev/jargons.dev

[FEATURE]: Add a text file containing all the words for dictionary based projects (auto-complete, auto-suggestions)

Open
#251 4 comments 0 reactions 1 assignee Claimed by @d093w1z View on GitHub
Dominant language
MDX
Stars
56
Forks
45
PR merge metrics
No merged PRs in 30d

Description

### Is this a unique feature/idea?

- [x] I have checked "open" AND "closed" issues and this is not a duplicate

### Is your feature request related to a problem/unavailable functionality? Please describe.

There isn't a simple list of words of our dictionary that can be used by anyone for a dictionary/word based project.
I use [Obsidian](https://obsidian.md/) for my note-taking and needed a jargon word-list.

### Proposed Solution

Add a text file that is accessible directly to anyone that contains all the words in a simple '.txt' format.
I believe jargon words are rarely ever used for suggestive help in text editors/ note taking apps. This feature would help people use our dictionary as a word-list for suggestions.
This feature is something similar to [dwyl/english-words](https://github.com/dwyl/english-words) but using our dictionary.

### Screenshots

_No response_

### Do you want to work on this issue?

Yes

### If "yes" to above, please explain how you would technically implement this

I propose a GitHub Actions script that is triggered whenever the directory contents of "src/content/dictionary" are changed.

This script will generate a list of the files in that directory and add it to a file called word-list.txt.

This will serve as a jargon word list.

This script will update the word list file and make a commit.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.