Refactor docs

Author: wooorm

index.js

@@ -1,4 +1,5 @@
 /**
+ * @typedef {import('./lib/index.js').Handler} Handler
  * @typedef {import('./lib/index.js').Options} Options
  */
 

lib/index.js

@@ -16,7 +16,7 @@
  *   Transform a node.
  * @param {any} node
  *   Node.
- * @returns {Array<Nodes> | Nodes | undefined}
+ * @returns {Array<Nodes> | Nodes | null | undefined}
  *   Result.
  *
  * @typedef {Partial<Record<Nodes['type'], Handler>>} Handlers
@@ -73,6 +73,11 @@ const emptyTypes = []
 /**
  * Remove markdown formatting.
  *
+ * * remove `code`, `html`, `horizontalRule`, `table`, `toml`, `yaml`, and
+ *   their content
+ * * render everything else as simple paragraphs without formatting
+ * * uses `alt` text for images
+ *
  * @param {Readonly<Options> | null | undefined} [options]
  *   Configuration (optional).
  * @returns
@@ -153,9 +158,9 @@ export default function stripMarkdown(options) {
     /** @type {Array<Nodes> | Nodes | undefined} */
     let result = node
 
-    if (type in map) {
+    if (Object.hasOwn(map, type)) {
       const handler = map[type]
-      if (handler) result = handler(result)
+      if (handler) result = handler(result) || undefined
     }
 
     result = Array.isArray(result) ? all(result) : result

package.json

@@ -35,16 +35,15 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/mdast": "^4.0.0",
-    "unified": "^11.0.0"
+    "@types/mdast": "^4.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
     "@types/unist": "^3.0.0",
     "c8": "^8.0.0",
     "prettier": "^3.0.0",
     "remark": "^15.0.0",
-    "remark-cli": "^11.0.0",
+    "remark-cli": "^12.0.0",
     "remark-directive": "^3.0.0",
     "remark-gfm": "^4.0.0",
     "remark-preset-wooorm": "^9.0.0",
@@ -70,7 +69,16 @@
   },
   "remarkConfig": {
     "plugins": [
-      "remark-preset-wooorm"
+      "remark-preset-wooorm",
+      [
+        "remark-lint-list-item-indent",
+        "space"
+      ],
+      [
+        "remark-preset-wooorm/node_modules/remark-gfm/index.js",
+        false
+      ],
+      "remark-gfm"
     ]
   },
   "typeCoverage": {

readme.md

@@ -8,29 +8,60 @@
 [![Backers][backers-badge]][collective]
 [![Chat][chat-badge]][chat]
 
-[**remark**][remark] plugin remove markdown formatting.
-This essentially removes everything but paragraphs and text nodes.
+**[remark][]** plugin to remove markdown formatting.
+This essentially removes everything but paragraphs and text.
 
 > This is one of the first remark plugins, before prefixing with `remark-` got
 > cool.
 
-## Note!
+## Contents
 
-This plugin is ready for the new parser in remark
-([`remarkjs/remark#536`](https://github.com/remarkjs/remark/pull/536)).
-No change is needed: it works exactly the same now as it did before!
+* [What is this?](#what-is-this)
+* [When should I use this?](#when-should-i-use-this)
+* [Install](#install)
+* [Use](#use)
+* [API](#api)
+  * [`unified().use(stripMarkdown[, options])`](#unifiedusestripmarkdown-options)
+  * [`Handler`](#handler)
+  * [`Options`](#options)
+* [Types](#types)
+* [Compatibility](#compatibility)
+* [Security](#security)
+* [Contribute](#contribute)
+* [License](#license)
 
-## Install
+## What is this?
+
+This package is a [unified][] ([remark][]) plugin to remove most nodes so as to
+just leave text.
+
+## When should I use this?
 
-This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
-Node 16+ is needed to use it and it must be `import`ed instead of `require`d.
+You can use this if you want to ignore the syntax of markdown.
 
-[npm][]:
+## Install
+
+This package is [ESM only][esm].
+In Node.js (version 16+), install with [npm][]:
 
 ```sh
 npm install strip-markdown
 ```
 
+In Deno with [`esm.sh`][esmsh]:
+
+```js
+import stripMarkdown from 'https://esm.sh/strip-markdown@5'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import stripMarkdown from 'https://esm.sh/strip-markdown@5?bundle'
+</script>
+```
+
 ## Use
 
 ```js
@@ -53,22 +84,70 @@ Some emphasis, importance, and code.
 ## API
 
 This package exports no identifiers.
-The default export is `stripMarkdown`.
+The default export is [`stripMarkdown`][api-strip-markdown].
 
 ### `unified().use(stripMarkdown[, options])`
 
-Plugin to remove markdown formatting.
+Remove markdown formatting.
+
+* remove `code`, `html`, `horizontalRule`, `table`, `toml`, `yaml`, and
+  their content
+* render everything else as simple paragraphs without formatting
+* uses `alt` text for images
+
+###### Parameters
+
+* `option` ([`Options`][api-options], optional)
+  — configuration
+
+###### Returns
+
+Transform ([`Transformer`][unified-transformer]).
+
+### `Handler`
+
+Transform a node (TypeScript type).
+
+###### Parameters
+
+* `node` ([`Node`][mdast-node])
+  — node
+
+###### Returns
+
+Result (`Array<Node>` or `Node`).
 
-*   Removes `html` ([*note*][gh-19]), `code`, `horizontalRule`, `table`, `yaml`,
-    `toml`, and their content
-*   Render everything else as simple paragraphs without formatting
-*   Uses `alt` text for images
+### `Options`
+
+Configuration (TypeScript type).
+
+###### Fields
+
+* `keep` (`Array<string>`, optional)
+  — list of node types to leave unchanged
+* `remove` (`Array<[string, Handler] | string>`, optional)
+  — list of node types to remove (or replace, with handlers)
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports the additional types [`Handler`][api-handler] and
+[`Options`][api-options].
+
+## Compatibility
+
+Projects maintained by the unified collective are compatible with maintained
+versions of Node.js.
+
+When we cut a new major release, we drop support for unmaintained versions of
+Node.
+This means we try to keep the current release line, `strip-markdown@5`,
+compatible with Node.js 12.
 
 ## Security
 
-Use of `strip-markdown` does not involve [**rehype**][rehype] ([**hast**][hast])
-or user content so there are no openings for [cross-site scripting (XSS)][xss]
-attacks.
+Use of `strip-markdown` does not involve **[rehype][]** (**[hast][]**) or user
+content so there are no openings for [cross-site scripting (XSS)][xss] attacks.
 
 ## Contribute
 
@@ -98,9 +177,9 @@ abide by its terms.
 
 [downloads]: https://www.npmjs.com/package/strip-markdown
 
-[size-badge]: https://img.shields.io/bundlephobia/minzip/strip-markdown.svg
+[size-badge]: https://img.shields.io/bundlejs/size/strip-markdown
 
-[size]: https://bundlephobia.com/result?p=strip-markdown
+[size]: https://bundlejs.com/?q=strip-markdown
 
 [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
 
@@ -114,24 +193,40 @@ abide by its terms.
 
 [npm]: https://docs.npmjs.com/cli/install
 
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
 [health]: https://github.com/remarkjs/.github
 
-[contributing]: https://github.com/remarkjs/.github/blob/HEAD/contributing.md
+[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
+
+[support]: https://github.com/remarkjs/.github/blob/main/support.md
 
-[support]: https://github.com/remarkjs/.github/blob/HEAD/support.md
+[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
 
-[coc]: https://github.com/remarkjs/.github/blob/HEAD/code-of-conduct.md
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
 
 [license]: license
 
 [author]: https://wooorm.com
 
-[remark]: https://github.com/remarkjs/remark
+[hast]: https://github.com/syntax-tree/hast
 
-[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+[mdast-node]: https://github.com/syntax-tree/mdast#nodes
 
 [rehype]: https://github.com/rehypejs/rehype
 
-[hast]: https://github.com/syntax-tree/hast
+[remark]: https://github.com/remarkjs/remark
+
+[typescript]: https://www.typescriptlang.org
+
+[unified]: https://github.com/unifiedjs/unified
+
+[unified-transformer]: https://github.com/unifiedjs/unified#transformer
+
+[api-handler]: #handler
+
+[api-options]: #options
 
-[gh-19]: https://github.com/remarkjs/strip-markdown/issues/19
+[api-strip-markdown]: #unifiedusestripmarkdown-options