Archived
1
0
Fork 0
This repository has been archived on 2024-10-19. You can view files and clone it, but cannot push or open issues or pull requests.
emacs/dictionaries/mk/readme.md

70 lines
1.4 KiB
Markdown

# dictionary-mk
Macedonian spelling dictionary in UTF-8.
Useful with [hunspell][], [`nodehun`][nodehun], [`nspell`][nspell],
Open Office, LibreOffice, FireFox and Thunderbird, or [macOS][].
Generated by [`dictionaries`][dictionaries], from
[`dimztimz/hunspell-mk`][source].
## Installation
[npm][]:
```bash
npm install dictionary-mk
```
## Usage
```js
var mk = require('dictionary-mk');
mk(function (err, result) {
console.log(err || result);
});
```
Yields:
```js
{ dic: <Buffer>,
aff: <Buffer> }
```
Where `dic` is a buffer for the dictionary file at `index.dic` (in UTF-8), and
`aff` is a buffer for the affix file at `index.aff` (in UTF-8).
Or directly load the files, using something like:
```js
var path = require('path');
var base = require.resolve('dictionary-mk');
// NEVER USE `readFileSync` IN PRODUCTION.
fs.readFileSync(path.join(base, 'index.dic'), 'utf-8');
fs.readFileSync(path.join(base, 'index.aff'), 'utf-8');
```
## License
Dictionary and affix file: [GPL-3.0](https://github.com/wooorm/dictionaries/blob/main/dictionaries/mk/license).
Rest: MIT © [Titus Wormer][home].
[hunspell]: http://hunspell.github.io
[nodehun]: https://github.com/nathanjsweet/nodehun
[nspell]: https://github.com/wooorm/nspell
[macos]: https://github.com/wooorm/dictionaries#macos
[source]: https://github.com/dimztimz/hunspell-mk
[npm]: https://docs.npmjs.com/cli/install
[dictionaries]: https://github.com/wooorm/dictionaries
[home]: https://wooorm.com