Skip to content

Commit 82d18ad

Browse files
committed
Add glossary
1 parent d9470a6 commit 82d18ad

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

readme.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ documents. The latest released version is [`1.1.0`](https://github.com/syntax-tr
2121
* [Node](#node)
2222
* [Parent](#parent)
2323
* [Text](#text)
24+
* [Glossary](#glossary)
2425
* [Unist files](#unist-files)
2526
* [Unist utilities](#unist-utilities)
2627
* [List of Utilities](#list-of-utilities)
@@ -127,6 +128,63 @@ interface Text <: Node {
127128
}
128129
```
129130

131+
## Glossary
132+
133+
###### Tree
134+
135+
A **tree** is a node and all of its **descendants** (if any).
136+
137+
###### Child
138+
139+
Node X is **child** of node Y, if Y’s `children` include X.
140+
141+
###### Parent
142+
143+
Node X is **parent** of node Y, if Y is a **child** of X.
144+
145+
###### Index
146+
147+
The **index** of a **child** is its number of preceding **siblings**, or `0` if
148+
it has none.
149+
150+
###### Sibling
151+
152+
Node X is a **sibling** of node Y, if X and Y have the same **parent** (if any).
153+
154+
The **previous sibling** of a **child** is its **sibling** at its **index**
155+
minus 1.
156+
157+
The **next sibling** of a **child** is its **sibling** at its **index**
158+
plus 1.
159+
160+
###### Root
161+
162+
The **root** of an object is itself, if without **parent**, or the **root** of
163+
its **parent**.
164+
165+
The **root** of a **tree** is any node in that **tree** without **parent**.
166+
167+
###### Descendant
168+
169+
Node X is **descendant** of node Y, if X is a **child** of Y, or if X is a
170+
**child** of node Z that is a **descendant** of Y.
171+
172+
An **inclusive descendant** is a node or one of its **descendants**.
173+
174+
###### Ancestor
175+
176+
Node X is an **ancestor** of node Y, if Y is a **descendant** of X.
177+
178+
An **inclusive ancestor** is a node or one of its **ancestors**.
179+
180+
###### Head
181+
182+
The **head** of a node is its first **child** (if any).
183+
184+
###### Tail
185+
186+
The **tail** of a node is its last **child** (if any).
187+
130188
## Unist files
131189

132190
**Unist files** are virtual files (such as [**vfile**][vfile])

0 commit comments

Comments
 (0)