HidemaruOwO/micromark-extension-directive
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Refactor docs

Browse source
This commit is contained in:
Titus Wormer 2023-06-29 11:57:04 +02:00
parent 1aa8ebf0da
commit 843ba9f0f3
No known key found for this signature in database
GPG key ID: E6E581152ED04E2E
1 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
readme.md
View file

@ -57,7 +57,7 @@ internals away.
## Install ## Install
This package is [ESM only][esm]. This package is [ESM only][esm].
In Node.js (version 14.14+), install with [npm][]: In Node.js (version 16+), install with [npm][]:
[npm][]: [npm][]:
@ -104,6 +104,7 @@ console.log(output)
/** /**
* @this {import('micromark-util-types').CompileContext} * @this {import('micromark-util-types').CompileContext}
* @type {import('micromark-extension-directive').Handle} * @type {import('micromark-extension-directive').Handle}
* @returns {undefined}
*/ */
function abbr(d) { function abbr(d) {
if (d.type !== 'textDirective') return false if (d.type !== 'textDirective') return false
@ -154,7 +155,7 @@ HTML.
###### Parameters ###### Parameters
* `options` ([`HtmlOptions`][api-html-options], optional) * `options` ([`HtmlOptions`][api-html-options], default: `{}`)
— configuration — configuration
###### Returns ###### Returns
@ -169,15 +170,15 @@ Structure representing a directive (TypeScript type).
###### Fields ###### Fields
* `type` (`'textDirective'`, `'leafDirective'`, or `'containerDirective'`) * `type` (`'containerDirective'`, `'leafDirective'`, or `'textDirective'`)
— kind — kind
* `name` (`string`) * `name` (`string`)
— name of directive — name of directive
* `label` (`string`, optional) * `label` (`string` or `undefined`)
— compiled HTML content that was in `[brackets]` — compiled HTML content that was in `[brackets]`
* `attributes` (`Record<string, string>`, optional) * `attributes` (`Record<string, string>` or `undefined`)
— object w/ HTML attributes — object w/ HTML attributes
* `content` (`string`, optional) * `content` (`string` or `undefined`)
— compiled HTML content inside container directive — compiled HTML content inside container directive
### `Handle` ### `Handle`
@ -306,12 +307,15 @@ It exports the additional types [`Directive`][api-directive-type],
## Compatibility ## Compatibility
Projects maintained by the unified collective are compatible with all maintained Projects maintained by the unified collective are compatible with maintained
versions of Node.js. versions of Node.js.
As of now, that is Node.js 14.14+.
Our projects sometimes work with older versions, but this is not guaranteed.
These extensions work with `micromark` version 3+. 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,
`micromark-extension-directive@^2`, compatible with Node.js 12.
This package works with `micromark` version `3` and later.
## Security ## Security
@ -354,9 +358,9 @@ abide by its terms.
[downloads]: https://www.npmjs.com/package/micromark-extension-directive [downloads]: https://www.npmjs.com/package/micromark-extension-directive
[size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-extension-directive.svg [size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-extension-directive
[size]: https://bundlephobia.com/result?p=micromark-extension-directive [size]: https://bundlejs.com/?q=micromark-extension-directive
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
@ -376,11 +380,11 @@ abide by its terms.
[author]: https://wooorm.com [author]: https://wooorm.com
[contributing]: https://github.com/micromark/.github/blob/HEAD/contributing.md [contributing]: https://github.com/micromark/.github/blob/main/contributing.md
[support]: https://github.com/micromark/.github/blob/HEAD/support.md [support]: https://github.com/micromark/.github/blob/main/support.md
[coc]: https://github.com/micromark/.github/blob/HEAD/code-of-conduct.md [coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c [esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c