172 lines
4.8 KiB
Markdown
172 lines
4.8 KiB
Markdown
# micromark-util-symbol
|
||
|
||
[![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 with symbols.
|
||
|
||
## Contents
|
||
|
||
* [What is this?](#what-is-this)
|
||
* [When should I use this?](#when-should-i-use-this)
|
||
* [Install](#install)
|
||
* [Use](#use)
|
||
* [API](#api)
|
||
* [Types](#types)
|
||
* [Compatibility](#compatibility)
|
||
* [Security](#security)
|
||
* [Contribute](#contribute)
|
||
* [License](#license)
|
||
|
||
## What is this?
|
||
|
||
This package exposes constants used throughout the micromark ecosystem.
|
||
|
||
## When should I use this?
|
||
|
||
This package is useful when you are making your own micromark extensions.
|
||
It’s useful to reference these constants by name instead of value while
|
||
developing.
|
||
[`micromark-build`][micromark-build] compiles them away for production code.
|
||
|
||
## Install
|
||
|
||
This package is [ESM only][esm].
|
||
In Node.js (version 16+), install with [npm][]:
|
||
|
||
```sh
|
||
npm install micromark-util-symbol
|
||
```
|
||
|
||
In Deno with [`esm.sh`][esmsh]:
|
||
|
||
```js
|
||
import {codes} from 'https://esm.sh/micromark-util-symbol/codes@1'
|
||
```
|
||
|
||
In browsers with [`esm.sh`][esmsh]:
|
||
|
||
```html
|
||
<script type="module">
|
||
import {codes} from 'https://esm.sh/micromark-util-symbol/codes@1?bundle'
|
||
</script>
|
||
```
|
||
|
||
## Use
|
||
|
||
```js
|
||
import {codes} from 'micromark-util-symbol/codes'
|
||
import {constants} from 'micromark-util-symbol/constants'
|
||
import {types} from 'micromark-util-symbol/types'
|
||
import {values} from 'micromark-util-symbol/values'
|
||
|
||
console.log(codes.atSign) // 64
|
||
console.log(constants.characterReferenceNamedSizeMax) // 31
|
||
console.log(types.definitionDestinationRaw) // 'definitionDestinationRaw'
|
||
console.log(values.atSign) // '@'
|
||
```
|
||
|
||
## API
|
||
|
||
This package has four entries in its export map: `micromark-util-symbol/codes`,
|
||
`micromark-util-symbol/constants`, `micromark-util-symbol/types`,
|
||
`micromark-util-symbol/values`.
|
||
|
||
Each module exports an identifier with the same name (for example,
|
||
`micromark-util-symbol/codes` has `codes`), which is an object mapping strings
|
||
to other values.
|
||
|
||
See the code for the exposed data.
|
||
|
||
## Types
|
||
|
||
This package is fully typed with [TypeScript][].
|
||
It exports no additional types.
|
||
|
||
## Compatibility
|
||
|
||
Projects maintained by the unified collective are compatible with all maintained
|
||
versions of Node.js.
|
||
As of now, that is Node.js 16+.
|
||
Our projects sometimes work with older versions, but this is not guaranteed.
|
||
|
||
This package works with `micromark` version 3+.
|
||
|
||
## Security
|
||
|
||
This package is safe.
|
||
See [`security.md`][securitymd] in [`micromark/.github`][health] for how to
|
||
submit a security report.
|
||
|
||
## Contribute
|
||
|
||
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.
|
||
|
||
## License
|
||
|
||
[MIT][license] © [Titus Wormer][author]
|
||
|
||
<!-- Definitions -->
|
||
|
||
[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-symbol.svg
|
||
|
||
[downloads]: https://www.npmjs.com/package/micromark-util-symbol
|
||
|
||
[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-util-symbol
|
||
|
||
[bundle-size]: https://bundlejs.com/?q=micromark-util-symbol
|
||
|
||
[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
|
||
|
||
[micromark-build]: https://github.com/micromark/micromark/tree/main/packages/micromark-build
|