Skip to content

Commit 05875cd

Browse files
committed
Refactor some docs
1 parent 0c2e0e8 commit 05875cd

File tree

1 file changed

+32
-11
lines changed

1 file changed

+32
-11
lines changed

readme.md

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,14 @@ Use [`micromark`][micromark] instead when you *just* want to turn markdown into
4545
HTML.
4646
For an easier time processing content, use the **[remark][]** ecosystem instead.
4747

48+
You can combine this utility with other utilities to add syntax extensions.
49+
Notable examples that deeply integrate with it are
50+
[`mdast-util-gfm`][mdast-util-gfm],
51+
[`mdast-util-mdx`][mdast-util-mdx],
52+
[`mdast-util-frontmatter`][mdast-util-frontmatter],
53+
[`mdast-util-math`][mdast-util-math], and
54+
[`mdast-util-directive`][mdast-util-directive].
55+
4856
## Install
4957

5058
This package is [ESM only][esm].
@@ -113,11 +121,10 @@ async function main() {
113121

114122
## API
115123

116-
This package exports the following identifier: `fromMarkdown`.
124+
This package exports the identifier `fromMarkdown`.
117125
There is no default export.
118126

119-
The export map supports the endorsed
120-
[`development` condition](https://nodejs.org/api/packages.html#packages_resolving_user_conditions).
127+
The export map supports the endorsed [`development` condition][development].
121128
Run `node --conditions development module.js` to get instrumented dev code.
122129
Without this condition, production code is loaded.
123130

@@ -192,9 +199,9 @@ The syntax tree is [mdast][].
192199
## Types
193200

194201
This package is fully typed with [TypeScript][].
195-
It exports the types `Value`, `Encoding`, `Options`, `Extension`, `Handle`,
196-
`Transform`, `Token`, `CompileContext`, `OnEnterError`, `OnExitError`, which
197-
model the interfaces used in parameters, options, and extensions.
202+
It exports the additional types `Value`, `Encoding`, `Options`, `Extension`,
203+
`Handle`, `Transform`, `Token`, `CompileContext`, `OnEnterError`, and
204+
`OnExitError`.
198205

199206
## Compatibility
200207

@@ -222,8 +229,8 @@ When going to HTML, use this utility in combination with
222229

223230
## Contribute
224231

225-
See [`contributing.md` in `syntax-tree/.github`][contributing] for ways to get
226-
started.
232+
See [`contributing.md`][contributing] in [`syntax-tree/.github`][health] for
233+
ways to get started.
227234
See [`support.md`][support] for ways to get help.
228235

229236
This project has a [code of conduct][coc].
@@ -270,18 +277,30 @@ abide by its terms.
270277

271278
[author]: https://wooorm.com
272279

273-
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
280+
[health]: https://github.com/syntax-tree/.github
281+
282+
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
274283

275-
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
284+
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
276285

277-
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
286+
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
278287

279288
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
280289

281290
[typescript]: https://www.typescriptlang.org
282291

283292
[mdast]: https://github.com/syntax-tree/mdast
284293

294+
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
295+
296+
[mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
297+
298+
[mdast-util-frontmatter]: https://github.com/syntax-tree/mdast-util-frontmatter
299+
300+
[mdast-util-math]: https://github.com/syntax-tree/mdast-util-math
301+
302+
[mdast-util-directive]: https://github.com/syntax-tree/mdast-util-directive
303+
285304
[root]: https://github.com/syntax-tree/mdast#root
286305

287306
[encoding]: https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
@@ -301,3 +320,5 @@ abide by its terms.
301320
[remark]: https://github.com/remarkjs/remark
302321

303322
[remark-parse]: https://github.com/remarkjs/remark/tree/main/packages/remark-parse
323+
324+
[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions

0 commit comments

Comments
 (0)