@cspell/dict-mn-mn 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +120 -16
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -4,43 +4,147 @@ Mongolian dictionary for cspell.
4
4
 
5
5
  This is a pre-built dictionary for use with CSpell.
6
6
 
7
- ## Installation
7
+ <!--- @@inject: ../../static/requirements.md --->
8
8
 
9
- Global Install and add to CSpell global settings.
9
+ ## Requirements
10
+
11
+ | Tool | Version |
12
+ | ------------------------------------------------------------------------------------------------------------------------------------ | ------- |
13
+ | [cspell](https://github.com/streetsidesoftware/cspell) | `>= 8` |
14
+ | [Code Spell Checker - Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) | `>= 4` |
15
+
16
+ <!--- @@inject-end: ../../static/requirements.md --->
17
+
18
+ <!--- @@inject: ./static/install.md --->
19
+
20
+ ## Local Installation
10
21
 
11
22
  ```sh
12
- npm install -g @cspell/dict-mn-mn
13
- cspell link add @cspell/dict-mn-mn
23
+ npm install -D @cspell/dict-mn-mn
14
24
  ```
15
25
 
16
- ## Uninstall from CSpell
26
+ ## Configuration
17
27
 
18
- ```sh
19
- cspell link remove @cspell/dict-mn-mn
28
+ <details>
29
+ <summary>VSCode Settings</summary>
30
+
31
+ Add the following to your VSCode settings:
32
+
33
+ **`.vscode/settings.json`**
34
+
35
+ ```jsonc
36
+ {
37
+ "cSpell.import": ["@cspell/dict-mn-mn/cspell-ext.json"],
38
+ "cSpell.language": "mn, mn-MN",
39
+ }
20
40
  ```
21
41
 
22
- ## Manual Installation
42
+ </details>
43
+
44
+ <details>
45
+ <summary>CSpell Settings <code>cspell.json</code></summary>
23
46
 
24
- Manual installation is useful if you want to include this dictionary as part of your CI/CD lint process.
47
+ **`cspell.json`**
25
48
 
49
+ ```jsonc
50
+ {
51
+ "import": ["@cspell/dict-mn-mn/cspell-ext.json"],
52
+ "language": "mn, mn-MN",
53
+ }
54
+ ```
55
+
56
+ </details>
57
+
58
+ <details>
59
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
60
+
61
+ **`cspell.config.yaml`**
62
+
63
+ ```yaml
64
+ import:
65
+ - '@cspell/dict-mn-mn/cspell-ext.json'
66
+ language: mn, mn-MN
26
67
  ```
27
- npm i @cspell/dict-mn-mn
68
+
69
+ </details>
70
+
71
+ ## Local Installation using CDN
72
+
73
+ ## CDN Configuration
74
+
75
+ <details>
76
+ <summary>VSCode Settings</summary>
77
+
78
+ Add the following to your VSCode settings:
79
+
80
+ **`.vscode/settings.json`**
81
+
82
+ ```jsonc
83
+ {
84
+ "cSpell.import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn/cspell-ext.json"],
85
+ "cSpell.language": "mn, mn-MN",
86
+ }
28
87
  ```
29
88
 
30
- The `cspell-ext.json` file in this package should be added to the import section in your `cspell.json` file.
89
+ </details>
90
+
91
+ <details>
92
+ <summary>CSpell Settings <code>cspell.json</code></summary>
93
+
94
+ **`cspell.json`**
31
95
 
32
- ```javascript
96
+ ```jsonc
33
97
  {
34
- //
35
- "import": ["@cspell/dict-mn-mn/cspell-ext.json"],
36
- // …
98
+ "import": ["https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn/cspell-ext.json"],
99
+ "language": "mn, mn-MN",
37
100
  }
38
101
  ```
39
102
 
40
- # Dictionary Development
103
+ </details>
104
+
105
+ <details>
106
+ <summary>CSpell Settings <code>cspell.config.yaml</code></summary>
107
+
108
+ **`cspell.config.yaml`**
109
+
110
+ ```yaml
111
+ import:
112
+ - https://cdn.jsdelivr.net/npm/@cspell/dict-mn-mn/cspell-ext.json
113
+ language: mn, mn-MN
114
+ ```
115
+
116
+ </details>
117
+
118
+ ## Dictionary Information
119
+
120
+ | Name | Enabled | Description |
121
+ | ------- | ------- | --------------------- |
122
+ | `mn-mn` | | Mongolian dictionary. |
123
+
124
+ ## Language Settings
125
+
126
+ | Name | Locale | File Type |
127
+ | ------- | ------------- | --------- |
128
+ | `mn-mn` | `mn`, `mn-MN` | `*` |
129
+
130
+ <!--- @@inject-end: ./static/install.md --->
131
+
132
+ <!--- @@inject: ../../static/contributing.md --->
133
+
134
+ ## Contributing
135
+
136
+ Please help correct any mistakes in the dictionaries.
137
+
138
+ See: [Contributing](https://github.com/streetsidesoftware/cspell-dicts#contributing)
139
+
140
+ Special thanks to all of our amazing contributors!
141
+
142
+ ### Dictionary Development
41
143
 
42
144
  See: [How to Create a New Dictionary](https://github.com/streetsidesoftware/cspell-dicts#how-to-create-a-new-dictionary)
43
145
 
146
+ <!--- @@inject-end: ../../static/contributing.md --->
147
+
44
148
  ## License
45
149
 
46
150
  MIT
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cspell/dict-mn-mn",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "Mongolian dictionary for cspell.",
5
5
  "publishConfig": {
6
6
  "access": "public",
@@ -50,5 +50,5 @@
50
50
  "*.js",
51
51
  "*.d.ts"
52
52
  ],
53
- "gitHead": "d4802eec07d74c523d6004b00ee20d30866ae29d"
53
+ "gitHead": "627831379fe16dbfcfbf05fe747f05320b86e615"
54
54
  }