8
8
[ ![ Backers] [ backers-badge ]] [ collective ]
9
9
[ ![ Chat] [ chat-badge ]] [ chat ]
10
10
11
- Check if an [ NLCST] [ ] node is meant literally. Useful if a tool wants to
12
- exclude these values possibly void of meaning.
11
+ [ ** nlcst** ] [ nlcst ] utility to check if a node is meant literally.
13
12
14
- As an example, a spell-checker could exclude these literal words, thus not
15
- warning about “monsieur”.
13
+ Useful if a tool wants to exclude values that are possibly void of meaning.
14
+ For example, a spell-checker could exclude these literal words, thus not warning
15
+ about “monsieur”.
16
16
17
- ## Installation
17
+ ## Install
18
18
19
19
[ npm] [ ] :
20
20
21
- ``` bash
21
+ ``` sh
22
22
npm install nlcst-is-literal
23
23
```
24
24
@@ -40,7 +40,7 @@ The word — quux — is meant as a literal.
40
40
41
41
And our script, ` example.js ` , looks as follows:
42
42
43
- ``` javascript
43
+ ``` js
44
44
var vfile = require (' to-vfile' )
45
45
var unified = require (' unified' )
46
46
var english = require (' retext-english' )
@@ -49,6 +49,7 @@ var toString = require('nlcst-to-string')
49
49
var literal = require (' nlcst-is-literal' )
50
50
51
51
var file = vfile .readSync (' example.txt' )
52
+
52
53
var tree = unified ()
53
54
.use (english)
54
55
.parse (file)
@@ -87,11 +88,13 @@ For example, `foo` is literal in the following samples:
87
88
88
89
## Contribute
89
90
90
- See [ ` contributing.md ` in ` syntax-tree/nlcst ` ] [ contributing ] for ways to get
91
+ See [ ` contributing.md ` in ` syntax-tree/.github ` ] [ contributing ] for ways to get
91
92
started.
93
+ See [ ` support.md ` ] [ support ] for ways to get help.
92
94
93
- This organisation has a [ Code of Conduct] [ coc ] . By interacting with this
94
- repository, organisation, or community you agree to abide by its terms.
95
+ This project has a [ Code of Conduct] [ coc ] .
96
+ By interacting with this repository, organisation, or community you agree to
97
+ abide by its terms.
95
98
96
99
## License
97
100
@@ -131,8 +134,10 @@ repository, organisation, or community you agree to abide by its terms.
131
134
132
135
[ author ] : https://wooorm.com
133
136
134
- [ nlcst ] : https://github.com/syntax-tree/nlcst
137
+ [ contributing ] : https://github.com/syntax-tree/.github/blob/master/contributing.md
135
138
136
- [ contributing ] : https://github.com/syntax-tree/nlcst /blob/master/contributing .md
139
+ [ support ] : https://github.com/syntax-tree/.github /blob/master/support .md
137
140
138
- [ coc ] : https://github.com/syntax-tree/nlcst/blob/master/code-of-conduct.md
141
+ [ coc ] : https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
142
+
143
+ [ nlcst ] : https://github.com/syntax-tree/nlcst
0 commit comments