[![Build][build-badge]][build] [![Coverage][coverage-badge]][coverage] [![Downloads][downloads-badge]][downloads] [![Size][bundle-size-badge]][bundle-size] [![Sponsors][sponsors-badge]][opencollective] [![Backers][backers-badge]][opencollective] [![Chat][chat-badge]][chat]
[micromark][] utility to encode dangerous html characters.
* What is this?
* When should I use this?
* Install
* Use
* API
* encode(value)
* Types
* Compatibility
* Security
* Contribute
* License
This package exposes an algorithm to make text safe for embedding in HTML.
This package might be useful when you are making your own micromark extensions.
This package is [ESM only][esm]. In Node.js (version 16+), install with [npm][]:
npm install micromark-util-encode
In Deno with [esm.sh][esmsh]:
import {encode} from 'https://esm.sh/micromark-util-encode@1'
In browsers with [esm.sh][esmsh]:
import {encode} from 'micromark-util-encode'encode('<3') // '<3'
This module exports the identifier [encode][api-encode].
There is no default export.
encode(value)Encode only the dangerous HTML characters.
This ensures that certain characters which have special meaning in HTML are
dealt with.
Technically, we can skip > and " in many cases, but CM includes them.
###### Parameters
* value (string)
— value to encode
###### Returns
Encoded value (string).
This package is fully typed with [TypeScript][]. It exports no additional types.
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,
micromark-util-encode@2, compatible with Node.js 16.
This package works with micromark@3.
This package is safe.
See [security.md][securitymd] in [micromark/.github][health] for how to
submit a security report.
See [contributing.md][contributing] in [micromark/.github][health] for ways
to get started.
See [support.md][support] for ways to get help.
This project has a [code of conduct][coc]. By interacting with this repository, organisation, or community you agree to abide by its terms.
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg
[build]: https://github.com/micromark/micromark/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg
[coverage]: https://codecov.io/github/micromark/micromark
[downloads-badge]: https://img.shields.io/npm/dm/micromark-util-encode.svg
[downloads]: https://www.npmjs.com/package/micromark-util-encode
[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-encode
[bundle-size]: https://bundlejs.com/?q=micromark-util-encode
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[opencollective]: https://opencollective.com/unified
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/micromark/micromark/discussions
[license]: https://github.com/micromark/micromark/blob/main/license
[author]: https://wooorm.com
[health]: https://github.com/micromark/.github
[securitymd]: https://github.com/micromark/.github/blob/main/security.md
[contributing]: https://github.com/micromark/.github/blob/main/contributing.md
[support]: https://github.com/micromark/.github/blob/main/support.md
[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md
[typescript]: https://www.typescriptlang.org
[micromark]: https://github.com/micromark/micromark
[api-encode]: #encodevalue