Skip to content

Commit 52bc7bb

Browse files
committed
Refactor prose
1 parent 3882f31 commit 52bc7bb

File tree

2 files changed

+37
-21
lines changed

2 files changed

+37
-21
lines changed

package.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,13 @@
2121
},
2222
"remarkConfig": {
2323
"plugins": [
24-
"preset-wooorm"
24+
"preset-wooorm",
25+
[
26+
"toc",
27+
{
28+
"heading": "contents"
29+
}
30+
]
2531
]
2632
}
2733
}

readme.md

Lines changed: 30 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This document may not be released.
1414
See [releases][] for released documents.
1515
The latest released version is [`3.0.0`][latest].
1616

17-
## Table of Contents
17+
## Contents
1818

1919
* [Introduction](#introduction)
2020
* [Where this specification fits](#where-this-specification-fits)
@@ -67,7 +67,7 @@ The latest released version is [`3.0.0`][latest].
6767
* [`PhrasingContent`](#phrasingcontent)
6868
* [`StaticPhrasingContent`](#staticphrasingcontent)
6969
* [Glossary](#glossary)
70-
* [List of Utilities](#list-of-utilities)
70+
* [List of utilities](#list-of-utilities)
7171
* [References](#references)
7272
* [Security](#security)
7373
* [Contribute](#contribute)
@@ -285,15 +285,17 @@ interface List <: Parent {
285285
Its content model is [**list**][dfn-list-content] content.
286286

287287
An `ordered` field can be present.
288-
It represents that the items have been intentionally ordered (when true), or
288+
It represents that the items have been intentionally ordered (when `true`), or
289289
that the order of items is not important (when `false` or not present).
290290

291-
If the `ordered` field is `true`, a `start` field can be present.
292-
It represents the starting number of the node.
291+
A `start` field can be present.
292+
It represents, when the `ordered` field is `true`, the starting number of the
293+
list.
293294

294295
A `spread` field can be present.
295-
It represents that any of its items is separated by a blank line from its
296-
[siblings][term-sibling] (when `true`), or not (when `false` or not present).
296+
It represents that one or more of its children are separated with a blank line
297+
from its [siblings][term-sibling] (when `true`), or not (when `false` or not
298+
present).
297299

298300
For example, the following Markdown:
299301

@@ -466,7 +468,8 @@ interface TableCell <: Parent {
466468
cell otherwise.
467469

468470
**TableCell** can be used where [**row**][dfn-row-content] content is expected.
469-
Its content model is [**phrasing**][dfn-phrasing-content] content.
471+
Its content model is [**phrasing**][dfn-phrasing-content] content excluding
472+
[**Break**][dfn-break] nodes.
470473

471474
For an example, see [**Table**][dfn-table].
472475

@@ -484,6 +487,9 @@ interface HTML <: Literal {
484487
[**phrasing**][dfn-phrasing-content] content is expected.
485488
Its content is represented by its `value` field.
486489

490+
HTML nodes do not have the restriction of being valid or complete HTML
491+
([\[HTML\]][html]) constructs.
492+
487493
For example, the following Markdown:
488494

489495
```markdown
@@ -568,7 +574,7 @@ interface YAML <: Literal {
568574
```
569575

570576
**YAML** ([**Literal**][dfn-literal]) represents a collection of metadata for
571-
the document in the [YAML][] data serialisation language.
577+
the document in the YAML ([\[YAML\]][yaml]) data serialisation language.
572578

573579
**YAML** can be used where [**frontmatter**][dfn-frontmatter-content] content is
574580
expected.
@@ -1186,14 +1192,16 @@ enum alignType {
11861192
}
11871193
```
11881194

1189-
**alignType** represents how phrasing content is aligned.
1195+
**alignType** represents how phrasing content is aligned
1196+
([\[CSSTEXT\]][css-text]).
11901197

1191-
* **left**: See the [`left`][css-left] value of the `text-align` CSS property
1192-
* **right**: See the [`right`][css-right] value of the `text-align` CSS
1198+
* **`'left'`**: See the [`left`][css-left] value of the `text-align` CSS
11931199
property
1194-
* **center**: See the [`center`][css-center] value of the `text-align` CSS
1195-
property
1196-
* **null**: phrasing content is aligned as defined by the host environment
1200+
* **`'right'`**: See the [`right`][css-right] value of the `text-align`
1201+
CSS property
1202+
* **`'center'`**: See the [`center`][css-center] value of the `text-align`
1203+
CSS property
1204+
* **`null`**: phrasing content is aligned as defined by the host environment
11971205

11981206
### `referenceType`
11991207

@@ -1306,7 +1314,7 @@ markup, that is not intended for user interaction.
13061314

13071315
See the [unist glossary][glossary].
13081316

1309-
## List of Utilities
1317+
## List of utilities
13101318

13111319
See the [unist list of utilities][utilities] for more utilities.
13121320

@@ -1404,11 +1412,11 @@ ways to get started.
14041412
See [`support.md`][support] for ways to get help.
14051413
Ideas for new utilities and tools can be posted in [`syntax-tree/ideas`][ideas].
14061414

1407-
A curated list of awesome syntax-tree, unist, hast, mdast, and nlcst resources
1408-
can be found in [awesome syntax-tree][awesome].
1415+
A curated list of awesome syntax-tree, unist, mdast, hast, xast, and nlcst
1416+
resources can be found in [awesome syntax-tree][awesome].
14091417

1410-
This project has a [Code of Conduct][coc].
1411-
By interacting with this repository, organisation, or community you agree to
1418+
This project has a [code of conduct][coc].
1419+
By interacting with this repository, organization, or community you agree to
14121420
abide by its terms.
14131421

14141422
## Acknowledgments
@@ -1503,6 +1511,8 @@ projects!
15031511

15041512
[dfn-table]: #table
15051513

1514+
[dfn-break]: #break
1515+
15061516
[dfn-link-reference]: #linkreference
15071517

15081518
[dfn-image-reference]: #imagereference

0 commit comments

Comments
 (0)