Update docs

retextjs · Nov 17, 2018 · 58913df · 58913df
1 parent 03300fc
commit 58913df
Show file tree

Hide file tree

Showing 9 changed files with 395 additions and 87 deletions.
diff --git a/contributing.md b/contributing.md
@@ -1,7 +1,8 @@
 # Contributing
 
-> This project has a [Code of Conduct][coc].  By interacting with this
-> repository, organisation, or community you agree to abide by its terms.
+> This project has a [Code of Conduct][coc].
+> By interacting with this repository, organisation, or community you agree to
+> abide by its terms.
 
 Hi!  👋
 We’re excited that you’re interested in contributing!
@@ -31,8 +32,8 @@ The ecosystem consists of several organisations and separate projects: most of
 them are tiny, and many of them have a utility
 ([`mdast-util-to-hast`][mdast-util-to-hast]), a plugin
 ([`remark-rehype`][remark-rehype]), and relate to an ecosystem
-([`remark`][remark]).  Try and pick the right place to contribute to so we can
-help you faster.
+([`remark`][remark]).
+Try and pick the right place to contribute to so we can help you faster.
 
 ## Questions
 
@@ -53,6 +54,16 @@ Jump in there and lurk, talk to us, and help others.
 
 There’s several ways to contribute, not just by writing code.
 
+### Financial support
+
+It’s possible to support us financially by becoming a backer or sponsor through
+[Open Collective][collective].
+With this support, we can pay for project leadership, finance non-coding work,
+or to do fun things for the community like getting stickers for contributors.
+You’ll be helping unified’s maintainers manage and improve existing projects,
+and additionally support our work to develop new and exciting projects, such
+as [micromark][].
+
 ### Improve documentation
 
 As a user of this project you’re perfect for helping us improve our docs.
@@ -128,3 +139,7 @@ prevent you from doing unnecessary work.
 [remark-rehype]: https://github.com/remarkjs/remark-rehype
 
 [unit-test]: https://twitter.com/sindresorhus/status/579306280495357953
+
+[collective]: https://opencollective.com/unified
+
+[micromark]: https://github.com/micromark/micromark
diff --git a/doc/getting-started.md b/doc/getting-started.md
@@ -16,7 +16,7 @@ retext is built on [unified][], make sure to read it and its [website][] too.
 ## Introduction
 
 Out of the box, **retext** doesn’t do anything.
-But, much can be done, [through plugins][plugins].
+But much can be done [through plugins][plugins].
 
 ## Programmatic usage
 

diff --git a/doc/plugins.md b/doc/plugins.md
@@ -2,7 +2,8 @@
 
 # Plugins
 
-**retext** is an ecosystem of [plugins][plugins].
+**retext** is a natural language processor powered by plugins part of the
+[unified][] [collective][].
 
 ## Table of Contents
 
@@ -13,92 +14,100 @@
 
 ## List of Plugins
 
+See [awesome retext][awesome] for the most awesome projects in the ecosystem.
+More plugins can be found on GitHub tagged with the
+[`retext-plugin` topic][topic].
+
+Have a good idea for a new plugin?
+See [Creating plugins][create] below.
+
 *   [`retext-cliches`](https://github.com/dunckr/retext-cliches)
-    — Check phrases for cliches
+    — check phrases for cliches
 *   [`retext-contractions`](https://github.com/retextjs/retext-contractions)
-    — Check apostrophe use in contractions
+    — check apostrophe use in contractions
 *   [`retext-diacritics`](https://github.com/retextjs/retext-diacritics)
-    — Check for proper use of diacritics
+    — check for proper use of diacritics
 *   [`retext-dutch`](https://github.com/retextjs/retext/tree/master/packages/retext-dutch)
-    — Dutch language support
+    — dutch language support
 *   [`retext-english`](https://github.com/retextjs/retext/tree/master/packages/retext-english)
     — English language support
 *   [`retext-emoji`](https://github.com/retextjs/retext-emoji)
-    — Encode or decode [Gemojis](https://github.com/github/gemoji)
+    — encode or decode [gemoji](https://github.com/github/gemoji)
 *   [`retext-equality`](https://github.com/retextjs/retext-equality)
-    — Warn about possible insensitive, inconsiderate language
+    — warn about possible insensitive, inconsiderate language
 *   [`retext-indefinite-article`](https://github.com/retextjs/retext-indefinite-article)
-    — Check if indefinite articles (`a`, `an`) are used correctly
+    — check if indefinite articles (`a`, `an`) are used correctly
 *   [`retext-keywords`](https://github.com/retextjs/retext-keywords)
-    — Extract keywords and keyphrases
+    — extract keywords and keyphrases
 *   [`retext-latin`](https://github.com/retextjs/retext/tree/master/packages/retext-latin)
     — Latin-script language support
 *   [`retext-overuse`](https://github.com/dunckr/retext-overuse)
-    — Check words for overuse
+    — check words for overuse
 *   [`retext-passive`](https://github.com/retextjs/retext-passive)
-    — Check for passive voice
+    — check for passive voice
 *   [`retext-profanities`](https://github.com/retextjs/retext-profanities)
-    — Check profane and vulgar wording
+    — check profane and vulgar wording
 *   [`retext-readability`](https://github.com/retextjs/retext-readability)
-    — Check readability
+    — check readability
 *   [`retext-redundant-acronyms`](https://github.com/retextjs/retext-redundant-acronyms)
-    — Check redundant acronyms (`ATM machine` > `ATM`)
+    — check redundant acronyms (`ATM machine` > `ATM`)
 *   [`retext-repeated-words`](https://github.com/retextjs/retext-repeated-words)
-    — Check `for for` repeated words
+    — check `for for` repeated words
 *   [`retext-sentence-spacing`](https://github.com/retextjs/retext-sentence-spacing)
-    — Check spacing between sentences
+    — check spacing between sentences
 *   [`retext-sentiment`](https://github.com/retextjs/retext-sentiment)
-    — Detect sentiment in text
+    — detect sentiment in text
 *   [`retext-simplify`](https://github.com/retextjs/retext-simplify)
-    — Check phrases for simpler alternatives
+    — check phrases for simpler alternatives
 *   [`retext-smartypants`](https://github.com/retextjs/retext-smartypants)
-    — Implementation of [SmartyPants](https://daringfireball.net/projects/smartypants/)
+    — implementation of [SmartyPants](https://daringfireball.net/projects/smartypants/)
 *   [`retext-spell`](https://github.com/retextjs/retext-spell)
-    — Spelling checker
+    — check spelling
 *   [`retext-stringify`](https://github.com/retextjs/retext/tree/master/packages/retext-stringify)
-    — Compile back to text
+    — compile back to text
 *   [`retext-syntax-mentions`](https://github.com/retextjs/retext-syntax-mentions)
-    — Classify `@mentions` as syntax
+    — classify `@mentions` as syntax
 *   [`retext-usage`](https://github.com/admhlt/retext-usage)
-    — Check incorrect English usage
+    — check incorrect English usage
 *   [`retext-quotes`](https://github.com/retextjs/retext-quotes)
-    — Check quote and apostrophe usage
+    — check quote and apostrophe usage
 
 ## List of Utilities
 
-See [**nlcst**][nlcst-util] for a list of utilities for working with the CST.
-See [`unist`][unist-util] for other utilities which work with **nlcst** nodes,
-too.
-
-And finally, see [`vfile`][vfile-util] for a list of utilities for working with
+See [**nlcst**][nlcst-util] for a list of utilities for working with the syntax
+tree.
+See [`unist`][unist-util] for other utilities which work with **nlcst**
+nodes, too.
+Finally, see [**vfile**][vfile-util] for a list of utilities working with
 virtual files.
 
 ## Using plugins
 
-To use a plugin programmatically, invoke the [`use()`][unified-use] function.
+To use a plugin invoke the [`use()`][unified-use] function.
 
 ## Creating plugins
 
-First, read up on the [concept of plugins][unified-plugins].
+Have an idea for a plugin?
+Post it on [spectrum][] or in [ideas][] and make it happen!
+
+To create a plugin, first read up on the [concept of plugins][unified-plugins].
 Then, read the [guide on “Creating a plugin with unified”][guide].
-Finally, take one of existing [plugins][plugins], which looks similar to what
-you’re about to do, and work from there.
-If you get stuck, [issues][] and [spectrum][] are good places to get help.
+Finally, take one of existing plugins, which looks similar to what you’re about
+to make, and work from there.
+If you get stuck, [spectrum][], [ideas][], and [issues][] are good places to get
+help.
 
-You should pick a name prefixed by `retext-` (such as `retext-lint`).
+You should pick a name prefixed by `'retext-'`, such as `retext-spell`.
 
-Note that, if the thing you create cannot be given to `retext().use()`,
-it isn’t a “plugin”.
-Don’t use the `retext-` prefix as that could confuse users.
-If it works with the nlcst tree, use `'nlcst-'`, if it works with any Unist
-tree, use `unist-util-`, if it works with virtual files, use `vfile-`.
+**Do not use the `retext-` prefix** if the thing you create doesn’t work with
+`retext().use()`: it isn’t a “plugin” and will confuse users.
+If it works with nlcst, use `'nlcst-util-'`, if it works with any unist tree,
+use `unist-util-`, and if it works with virtual files, use `vfile-`.
 
 <!--Definitions:-->
 
 [logo]: https://raw.githubusercontent.com/retextjs/retext/976354b/logo.svg?sanitize=true
 
-[plugins]: #list-of-plugins
-
 [nlcst-util]: https://github.com/syntax-tree/nlcst#list-of-utilities
 
 [unist-util]: https://github.com/syntax-tree/unist#unist-node-utilties
@@ -114,3 +123,15 @@ tree, use `unist-util-`, if it works with virtual files, use `vfile-`.
 [spectrum]: https://spectrum.chat/unified/retext
 
 [guide]: https://unified.js.org/create-a-plugin.html
+
+[unified]: https://github.com/unifiedjs/unified
+
+[collective]: https://opencollective.com/unified
+
+[create]: #creating-plugins
+
+[awesome]: https://github.com/retextjs/awesome
+
+[ideas]: https://github.com/retextjs/ideas
+
+[topic]: https://github.com/topics/retext-plugin
diff --git a/packages/retext-dutch/readme.md b/packages/retext-dutch/readme.md
@@ -1,7 +1,44 @@
 # retext-dutch [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Chat][chat-badge]][chat]
 
 [Parser][] for [**unified**][unified].
-Parses the Dutch language to a syntax tree ([**nlcst**][nlcst]).
+Parses the Dutch language to [**nlcst**][nlcst] syntax trees.
+
+* * *
+
+**Announcing the unified collective!  🎉
+[Read more about it on Medium »][announcement]**
+
+## Sponsors
+
+<!--lint ignore no-html maximum-line-length-->
+
+<table>
+  <tr valign="top">
+    <td width="20%" align="center">
+      <a href="https://zeit.co"><img src="https://avatars1.githubusercontent.com/u/14985020?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://zeit.co">ZEIT</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://www.gatsbyjs.org">Gatsby</a></td>
+    <td width="20%" align="center">
+      <a href="https://compositor.io"><img src="https://avatars1.githubusercontent.com/u/19245838?s=400&v=4"></a>
+      <br><br>🥉
+      <a href="https://compositor.io">Compositor</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=400&v=4"></a>
+      <br><br>
+      <a href="https://www.holloway.com">Holloway</a>
+    </td>
+    <td width="20%" align="center">
+      <br><br><br><br>
+      <a href="https://opencollective.com/unified"><strong>You?</strong>
+    </td>
+  </tr>
+</table>
 
 ## Installation
 
@@ -86,3 +123,5 @@ Access to the [parser][] ([`parse-dutch`][parse-dutch]).
 [parser]: https://github.com/unifiedjs/unified#processorparser
 
 [parse-dutch]: https://github.com/wooorm/parse-dutch
+
+[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc
diff --git a/packages/retext-english/readme.md b/packages/retext-english/readme.md
@@ -1,7 +1,44 @@
 # retext-english [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Chat][chat-badge]][chat]
 
 [Parser][] for [**unified**][unified].
-Parses the English language to a syntax tree ([**nlcst**][nlcst]).
+Parses the English language to [**nlcst**][nlcst] syntax trees.
+
+* * *
+
+**Announcing the unified collective!  🎉
+[Read more about it on Medium »][announcement]**
+
+## Sponsors
+
+<!--lint ignore no-html maximum-line-length-->
+
+<table>
+  <tr valign="top">
+    <td width="20%" align="center">
+      <a href="https://zeit.co"><img src="https://avatars1.githubusercontent.com/u/14985020?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://zeit.co">ZEIT</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://www.gatsbyjs.org">Gatsby</a></td>
+    <td width="20%" align="center">
+      <a href="https://compositor.io"><img src="https://avatars1.githubusercontent.com/u/19245838?s=400&v=4"></a>
+      <br><br>🥉
+      <a href="https://compositor.io">Compositor</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=400&v=4"></a>
+      <br><br>
+      <a href="https://www.holloway.com">Holloway</a>
+    </td>
+    <td width="20%" align="center">
+      <br><br><br><br>
+      <a href="https://opencollective.com/unified"><strong>You?</strong>
+    </td>
+  </tr>
+</table>
 
 ## Installation
 
@@ -86,3 +123,5 @@ Access to the [parser][] ([`parse-english`][parse-english]).
 [parser]: https://github.com/unifiedjs/unified#processorparser
 
 [parse-english]: https://github.com/wooorm/parse-english
+
+[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc
diff --git a/packages/retext-latin/readme.md b/packages/retext-latin/readme.md
@@ -1,8 +1,46 @@
 # retext-latin [![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][size-badge]][size] [![Chat][chat-badge]][chat]
 
 [Parser][] for [**unified**][unified].
-Parses Latin-script natural language to a syntax tree ([**nlcst**][nlcst]).
-Used in the [**retext** processor][processor].
+Parses Latin-script language to [**nlcst**][nlcst] syntax trees.
+Used in the [**retext** processor][processor] but can be used on its own as
+well.
+
+* * *
+
+**Announcing the unified collective!  🎉
+[Read more about it on Medium »][announcement]**
+
+## Sponsors
+
+<!--lint ignore no-html maximum-line-length-->
+
+<table>
+  <tr valign="top">
+    <td width="20%" align="center">
+      <a href="https://zeit.co"><img src="https://avatars1.githubusercontent.com/u/14985020?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://zeit.co">ZEIT</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.gatsbyjs.org"><img src="https://avatars1.githubusercontent.com/u/12551863?s=400&v=4"></a>
+      <br><br>🥇
+      <a href="https://www.gatsbyjs.org">Gatsby</a></td>
+    <td width="20%" align="center">
+      <a href="https://compositor.io"><img src="https://avatars1.githubusercontent.com/u/19245838?s=400&v=4"></a>
+      <br><br>🥉
+      <a href="https://compositor.io">Compositor</a>
+    </td>
+    <td width="20%" align="center">
+      <a href="https://www.holloway.com"><img src="https://avatars1.githubusercontent.com/u/35904294?s=400&v=4"></a>
+      <br><br>
+      <a href="https://www.holloway.com">Holloway</a>
+    </td>
+    <td width="20%" align="center">
+      <br><br><br><br>
+      <a href="https://opencollective.com/unified"><strong>You?</strong>
+    </td>
+  </tr>
+</table>
 
 ## Installation
 
@@ -89,3 +127,5 @@ Access to the [parser][] ([`parse-latin`][parse-latin]).
 [parser]: https://github.com/unifiedjs/unified#processorparser
 
 [parse-latin]: https://github.com/wooorm/parse-latin
+
+[announcement]: https://medium.com/unifiedjs/collectively-evolving-through-crowdsourcing-22c359ea95cc