From 4530b2d0de698b88acd9deabb82a314665fe06ae Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Sun, 10 Dec 2017 13:33:43 +0100 Subject: [PATCH] Refactor docs --- readme.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index a9f0a8c..47fb9fc 100644 --- a/readme.md +++ b/readme.md @@ -69,12 +69,12 @@ Now, running `node example` yields: Adds slugs to markdown headings. -Uses [**github-slugger**][ghslug] (thus creating GitHub style `id`s). +Uses [`github-slugger`][ghslug], which creates GitHub-style slugs. -Sets `data.id`, `data.hProperties.id` on heading nodes. The first can be -used by any plugin as a unique identifier, the second tells **remark-html** -to use its value as an `id` attribute. **remark-slug** does not overwrite -these values when they already exist. +Sets `data.id` and `data.hProperties.id` on heading nodes. +The first can be used by any plugin as a unique identifier, the second tells +[`mdast-util-to-hast`][to-hast] (used in [`remark-html`][remark-html] and +[`remark-rehype`][remark-rehype]) to use its value as an `id` attribute. ## Related @@ -82,7 +82,8 @@ these values when they already exist. ## Contribute -See [`contribute.md` in `remarkjs/remarkj`][contribute] for ways to get started. +See [`contribute.md` in `remarkjs/remarkjs`][contribute] for ways to get +started. This organisation has a [Code of Conduct][coc]. By interacting with this repository, organisation, or community you agree to abide by its terms. @@ -115,8 +116,12 @@ repository, organisation, or community you agree to abide by its terms. [ghslug]: https://github.com/Flet/github-slugger +[to-hast]: https://github.com/syntax-tree/mdast-util-to-hast + [rehype-slug]: https://github.com/rehypejs/rehype-slug +[remark-html]: https://github.com/remarkjs/remark-html + [remark-rehype]: https://github.com/remarkjs/remark-rehype [rehype]: https://github.com/rehypejs/rehype