Skip to content

Commit 0a046fa

Browse files
committed
Refactor prose
1 parent 16f2b9b commit 0a046fa

File tree

1 file changed

+69
-21
lines changed

1 file changed

+69
-21
lines changed

readme.md

Lines changed: 69 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ The latest released version is [`2.3.0`][latest].
3131
* [List of Utilities](#list-of-utilities)
3232
* [Related HTML Utilities](#related-html-utilities)
3333
* [References](#references)
34+
* [Security](#security)
3435
* [Contribute](#contribute)
3536
* [Acknowledgments](#acknowledgments)
3637
* [License](#license)
@@ -193,12 +194,12 @@ DOM][concept-aria-reflection] ([\[ARIA\]][aria]), and differs from how some
193194
(older) HTML attributes are reflected in the DOM.
194195

195196
1. Any name referencing a combinations of multiple words (such as “stroke
196-
miter limit”) becomes a camel-cased property name capitalising each word
197+
miter limit”) becomes a camelcased property name capitalising each word
197198
boundary.
198199
This includes combinations that are sometimes written as several words.
199200
For example, `stroke-miterlimit` becomes `strokeMiterLimit`, `autocorrect`
200201
becomes `autoCorrect`, and `allowfullscreen` becomes `allowFullScreen`.
201-
2. Any name that can be hyphenated, becomes a camel-cased property name
202+
2. Any name that can be hyphenated, becomes a camelcased property name
202203
capitalising each boundary.
203204
For example, “read-only” becomes `readOnly`.
204205
3. Compound words that are not used with spaces or hyphens are treated as a
@@ -269,10 +270,11 @@ Where the DOM treats `<div hidden="no"></div>` as having a value of `true` and
269270
`<img width="yes">` as having a value of `0`, these should be reflected as
270271
`'no'` and `'yes'`, respectively, in hast.
271272

272-
> The reason for this is to allow plug-ins and utilities to inspect these
273+
> The reason for this is to allow plugins and utilities to inspect these
273274
> non-standard values.
274275
275-
The DOM also specifies comma- and space-separated lists attribute values.
276+
The DOM also specifies comma separated and space separated lists attribute
277+
values.
276278
In hast, these should be treated as ordered lists.
277279
For example, `<div class="alpha bravo"></div>` is represented as `['alpha',
278280
'bravo']`.
@@ -390,23 +392,23 @@ The rest is sorted alphabetically based on content after `hast-util-`
390392
* [`hast-to-hyperscript`](https://github.com/syntax-tree/hast-to-hyperscript)
391393
— Convert a Node to React, Virtual DOM, Hyperscript, and more
392394
* [`hast-util-assert`](https://github.com/syntax-tree/hast-util-assert)
393-
— Assert HAST nodes
395+
— Assert hast nodes
394396
* [`hast-util-class-list`](https://github.com/brechtcs/hast-util-class-list)
395-
— Simulate the browser’s `classList` API for HAST nodes
397+
— Simulate the browser’s `classList` API for hast nodes
396398
* [`hast-util-embedded`](https://github.com/syntax-tree/hast-util-embedded)
397399
— Check if `node` is embedded content
398400
* [`hast-util-find-and-replace`](https://github.com/syntax-tree/hast-util-find-and-replace)
399401
— Find and replace text
400402
* [`hast-util-from-dom`](https://github.com/syntax-tree/hast-util-from-dom)
401403
— Transform a DOM tree to hast
402404
* [`hast-util-from-parse5`](https://github.com/syntax-tree/hast-util-from-parse5)
403-
— Transform Parse5’s AST to HAST
405+
— Transform Parse5’s AST to hast
404406
* [`hast-util-from-string`](https://github.com/rehypejs/rehype-minify/tree/master/packages/hast-util-from-string)
405407
— Set the plain-text value of a node (`textContent`)
406408
* [`hast-util-from-text`](https://github.com/syntax-tree/hast-util-from-text)
407409
— Set the plain-text value of a node (`innerText`)
408410
* [`hast-util-from-webparser`](https://github.com/Prettyhtml/prettyhtml/tree/master/packages/hast-util-from-webparser)
409-
— Transform Webparser’s AST to HAST
411+
— Transform Webparser’s AST to hast
410412
* [`hast-util-has-property`](https://github.com/syntax-tree/hast-util-has-property)
411413
— Check if a node has a property
412414
* [`hast-util-heading`](https://github.com/syntax-tree/hast-util-heading)
@@ -436,7 +438,7 @@ The rest is sorted alphabetically based on content after `hast-util-`
436438
* [`hast-util-phrasing`](https://github.com/syntax-tree/hast-util-phrasing)
437439
— Check if a node is phrasing content
438440
* [`hast-util-raw`](https://github.com/syntax-tree/hast-util-raw)
439-
— Reparse a HAST tree
441+
— Reparse a hast tree
440442
* [`hast-util-sanitize`](https://github.com/syntax-tree/hast-util-sanitize)
441443
— Sanitise nodes
442444
* [`hast-util-script-supporting`](https://github.com/syntax-tree/hast-util-script-supporting)
@@ -456,11 +458,11 @@ The rest is sorted alphabetically based on content after `hast-util-`
456458
* [`hast-util-to-jsx`](https://github.com/mapbox/jsxtreme-markdown/tree/master/packages/hast-util-to-jsx)
457459
— Transform hast to JSX
458460
* [`hast-util-to-mdast`](https://github.com/syntax-tree/hast-util-to-mdast)
459-
— Transform HAST to MDAST
461+
— Transform hast to mdast
460462
* [`hast-util-to-nlcst`](https://github.com/syntax-tree/hast-util-to-nlcst)
461-
— Transform HAST to NLCST
463+
— Transform hast to nlcst
462464
* [`hast-util-to-parse5`](https://github.com/syntax-tree/hast-util-to-parse5)
463-
— Transform HAST to Parse5’s AST
465+
— Transform hast to Parse5’s AST
464466
* [`hast-util-to-snabbdom`](https://github.com/syntax-tree/hast-util-to-snabbdom)
465467
— Transform to a Snabbdom tree
466468
* [`hast-util-to-string`](https://github.com/rehypejs/rehype-minify/tree/master/packages/hast-util-to-string)
@@ -481,31 +483,35 @@ The rest is sorted alphabetically based on content after `hast-util-`
481483
* [`collapse-white-space`](https://github.com/wooorm/collapse-white-space)
482484
— Replace multiple white-space characters with a single space
483485
* [`comma-separated-tokens`](https://github.com/wooorm/comma-separated-tokens)
484-
— Parse/stringify comma-separated tokens
486+
— Parse/stringify comma separated tokens
485487
* [`html-tag-names`](https://github.com/wooorm/html-tag-names)
486-
— List of HTML tag-names
488+
— List of HTML tag names
487489
* [`html-dangerous-encodings`](https://github.com/wooorm/html-dangerous-encodings)
488490
— List of dangerous HTML character encoding labels
489491
* [`html-encodings`](https://github.com/wooorm/html-encodings)
490492
— List of HTML character encoding labels
491493
* [`html-element-attributes`](https://github.com/wooorm/html-element-attributes)
492494
— Map of HTML attributes
495+
* [`html-event-attributes`](https://github.com/wooorm/html-event-attributes)
496+
— List of HTML event handler content attributes
493497
* [`html-void-elements`](https://github.com/wooorm/html-void-elements)
494-
— List of void HTML tag-names
498+
— List of void HTML tag names
495499
* [`link-rel`](https://github.com/wooorm/link-rel)
496500
— List of link types for `rel` on `link`
497501
* [`mathml-tag-names`](https://github.com/wooorm/mathml-tag-names)
498-
— List of MathML tag-names
502+
— List of MathML tag names
499503
* [`meta-name`](https://github.com/wooorm/meta-name)
500504
— List of values for `name` on `meta`
501505
* [`property-information`](https://github.com/wooorm/property-information)
502506
— Information on HTML properties
503507
* [`space-separated-tokens`](https://github.com/wooorm/space-separated-tokens)
504-
— Parse/stringify space-separated tokens
508+
— Parse/stringify space separated tokens
505509
* [`svg-tag-names`](https://github.com/wooorm/svg-tag-names)
506-
— List of SVG tag-names
510+
— List of SVG tag names
507511
* [`svg-element-attributes`](https://github.com/wooorm/svg-element-attributes)
508512
— Map of SVG attributes
513+
* [`svg-event-attributes`](https://github.com/wooorm/svg-event-attributes)
514+
— List of SVG event handler content attributes
509515
* [`web-namespaces`](https://github.com/wooorm/web-namespaces)
510516
— Map of web namespaces
511517

@@ -596,14 +602,56 @@ Special thanks to [**@eush77**](https://github.com/eush77) for their work,
596602
ideas, and incredibly valuable feedback!
597603

598604
Thanks to
599-
[**@kthjm**](https://github.com/kthjm)
605+
[**@andrewburgess**](https://github.com/andrewburgess),
606+
[**@arobase-che**](https://github.com/arobase-che),
607+
[**@arystan-sw**](https://github.com/arystan-sw),
608+
[**@BarryThePenguin**](https://github.com/BarryThePenguin),
609+
[**@brechtcs**](https://github.com/brechtcs),
610+
[**@ChristianMurphy**](https://github.com/ChristianMurphy),
611+
[**@ChristopherBiscardi**](https://github.com/ChristopherBiscardi),
612+
[**@craftzdog**](https://github.com/craftzdog),
613+
[**@cupojoe**](https://github.com/cupojoe),
614+
[**@davidtheclark**](https://github.com/davidtheclark),
615+
[**@derhuerst**](https://github.com/derhuerst),
616+
[**@detj**](https://github.com/detj),
617+
[**@DxCx**](https://github.com/DxCx),
618+
[**@erquhart**](https://github.com/erquhart),
619+
[**@flurmbo**](https://github.com/flurmbo),
620+
[**@Hamms**](https://github.com/Hamms),
621+
[**@Hypercubed**](https://github.com/Hypercubed),
622+
[**@inklesspen**](https://github.com/inklesspen),
623+
[**@jeffal**](https://github.com/jeffal),
624+
[**@jlevy**](https://github.com/jlevy),
625+
[**@Justineo**](https://github.com/Justineo),
626+
[**@lfittl**](https://github.com/lfittl),
627+
[**@kgryte**](https://github.com/kgryte),
628+
[**@kmck**](https://github.com/kmck),
629+
[**@kthjm**](https://github.com/kthjm),
600630
[**@KyleAMathews**](https://github.com/KyleAMathews),
631+
[**@macklinu**](https://github.com/macklinu),
632+
[**@medfreeman**](https://github.com/medfreeman),
633+
[**@Murderlon**](https://github.com/Murderlon),
634+
[**@nevik**](https://github.com/nevik),
635+
[**@nokome**](https://github.com/nokome),
636+
[**@phiresky**](https://github.com/phiresky),
637+
[**@revolunet**](https://github.com/revolunet),
601638
[**@rhysd**](https://github.com/rhysd),
602639
[**@Rokt33r**](https://github.com/Rokt33r),
640+
[**@rubys**](https://github.com/rubys),
603641
[**@s1n**](https://github.com/s1n),
604642
[**@Sarah-Seo**](https://github.com/Sarah-Seo),
605-
[**@sethvincent**](https://github.com/sethvincent), and
606-
[**@simov**](https://github.com/simov)
643+
[**@sethvincent**](https://github.com/sethvincent),
644+
[**@simov**](https://github.com/simov),
645+
[**@s1n**](https://github.com/s1n),
646+
[**@StarpTech**](https://github.com/StarpTech),
647+
[**@stefanprobst**](https://github.com/stefanprobst),
648+
[**@stuff**](https://github.com/stuff),
649+
[**@subhero24**](https://github.com/subhero24),
650+
[**@tripodsan**](https://github.com/tripodsan),
651+
[**@tunnckoCore**](https://github.com/tunnckoCore),
652+
[**@vhf**](https://github.com/vhf),
653+
[**@voischev**](https://github.com/voischev), and
654+
[**@zjaml**](https://github.com/zjaml),
607655
for contributing to hast and related projects!
608656

609657
## License

0 commit comments

Comments
 (0)