mirror of
https://github.com/mii443/proof-dictionary.git
synced 2025-08-22 15:15:37 +00:00
45 lines
1.3 KiB
Markdown
45 lines
1.3 KiB
Markdown
# proof-dictionary
|
|
|
|
This dictionary is for [proofdict](https://github.com/proofdict/proofdict).
|
|
|
|
- Dictionary: <https://proofdict.github.io/proof-dictionary/redirect/?type=dictionary>
|
|
- Editor: <https://proofdict.github.io/proof-dictionary/redirect/?type=editor>
|
|
- JSON API: <https://proofdict.github.io/proof-dictionary/redirect/?type=api>
|
|
|
|
## Usage
|
|
|
|
### Add dictionary
|
|
|
|
If you want to add new rule to your dictionary, you can add new rule by following steps:
|
|
|
|
Visit your [editor page](https://proofdict.github.io/proof-dictionary/redirect/?type=editor):
|
|
|
|
- <https://proofdict.github.io/proof-dictionary/redirect/?type=editor>
|
|
|
|
### Update dictionary
|
|
|
|
If you want to update the rule from your dictionary, you can edit it by following steps:
|
|
|
|
1. Visit [_data/proofdict][]
|
|
2. Select the file for updating
|
|
3. Edit the file by click  icon
|
|
|
|
### Remove dictionary
|
|
|
|
If you want to remove unnecessary rule from your dictionary, you can remove it by following steps:
|
|
|
|
1. Visit [_data/proofdict][]
|
|
2. Select the file for removing
|
|
3. Remove the file by click  icon
|
|
|
|
### Test dictionary
|
|
|
|
You can check your proof-dictionary is valid format.
|
|
|
|
Run following command in your local:
|
|
|
|
npm install
|
|
npm test
|
|
|
|
[_data/proofdict]: _data/proofdict "dictionary data directory"
|