1
- # ![ Unist] ( https://cdn.rawgit.com/wooorm/unist/master/ logo.svg )
1
+ # ![ Unist] [ logo ]
2
2
3
3
** Unist** (** uni** versal ** s** yntax ** t** ree) is the combination of three
4
4
project, and more to come, which are the summation of at least
5
- [ two] ( https://github.com/wooorm/retext/commit/8fcb1ff4874d1891791280d63125d27ed29b58a8 )
6
- [ years] ( https://github.com/wooorm/remark/commit/19585b8 ) of my work and the
5
+ [ two] [ first-retext-commit ] [ years] [ first-remark-commit ] of my work and the
7
6
current epitome of that.
8
7
9
8
It’s basically a system for processing input: parsing it into a syntax tree,
10
9
transforming it by plug-ins, and compiling the tree to something else.
11
10
12
- This document explains some terminology relating to
13
- [ ** retext** ] ( https://github.com/wooorm/retext ) ,
14
- [ ** remark** ] ( https://github.com/wooorm/remark ) ,
15
- [ ** hast** ] ( https://github.com/wooorm/hast ) ,
16
- and their related projects.
11
+ This document explains some terminology relating to [ ** retext** ] [ retext ] ,
12
+ [ ** remark** ] [ remark ] , [ ** hast** ] [ hast ] , and their related projects.
17
13
18
14
## Unist nodes
19
15
@@ -30,7 +26,7 @@ and their related projects.
30
26
* may have a ` position ` property set to a an object containing ` start ` and
31
27
` end ` , both of which contain an object with ` line ` and ` column ` set
32
28
to an integer referencing their respective (1-based) line and column
33
- in the input file. Both may have an ` offset ` property set to its
29
+ in the input file. Both may have an ` offset ` property set to its
34
30
index from the beginning of the input.
35
31
The object at ` position ` may additionally have an ` indent ` property
36
32
set to an array of integers higher than 0 (not including), in which
@@ -39,23 +35,22 @@ and their related projects.
39
35
If a node represents something not available in the original input, it
40
36
must not have a ` position ` .
41
37
42
- See [ ** nlcst** ] ( https://github.com/wooorm/nlcst ) for more information
43
- on ** retext** nodes, [ ** mdast** ] ( https://github.com/wooorm/mdast )
44
- for information on ** remark** nodes, and [ ` hast#nodes ` ] ( https://github.com/wooorm/hast#nodes )
45
- for information on ** hast** nodes.
38
+ See [ ** nlcst** ] [ nlcst ] for more information on ** retext** nodes,
39
+ [ ** mdast** ] [ mdast ] for information on ** remark** nodes, and
40
+ [ ` hast#nodes ` ] [ hast-nodes ] for information on ** hast** nodes.
46
41
47
42
## Unist files
48
43
49
- ** Unist files** are virtual files (such as [ ** vfile** ] ( https://github.com/wooorm/ vfile) )
50
- representing content at a certain location. They are not limited to existing
51
- files. Neither are they limited to the file-system only.
44
+ ** Unist files** are virtual files (such as [ ** vfile** ] [ vfile ] )
45
+ representing content at a certain location. They are not limited to
46
+ existing files. Neither are they limited to the file-system only.
52
47
53
48
## Unist utilities
54
49
55
50
** Unist utilities** are function which work with ** unist nodes** or ** unist
56
51
files** , agnostic of ** remark** , ** retext** , or ** hast** .
57
52
58
- A list of ** VFile** -related utilities can be found at [ ** vfile** ] ( https://github.com/wooorm/ vfile) .
53
+ A list of ** VFile** -related utilities can be found at [ ** vfile** ] [ vfile ] .
59
54
60
55
### Unist node utilties
61
56
@@ -101,3 +96,25 @@ A list of **VFile**-related utilities can be found at [**vfile**](https://github
101
96
102
97
* [ ` unist-builder ` ] ( https://github.com/eush77/unist-builder )
103
98
— Helper for creating trees.
99
+
100
+ <!-- Definitions -->
101
+
102
+ [ logo ] : https://cdn.rawgit.com/wooorm/unist/master/logo.svg
103
+
104
+ [ first-retext-commit ] : https://github.com/wooorm/retext/commit/8fcb1ff
105
+
106
+ [ first-remark-commit ] : https://github.com/wooorm/remark/commit/19585b8
107
+
108
+ [ retext ] : https://github.com/wooorm/retext
109
+
110
+ [ remark ] : https://github.com/wooorm/remark
111
+
112
+ [ hast ] : https://github.com/wooorm/hast
113
+
114
+ [ nlcst ] : https://github.com/wooorm/nlcst
115
+
116
+ [ mdast ] : https://github.com/wooorm/mdast
117
+
118
+ [ hast-nodes ] : https://github.com/wooorm/hast#nodes
119
+
120
+ [ vfile ] : https://github.com/wooorm/vfile
0 commit comments