sidski/kjelsrud.dev
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

🎉 initiate project *astro_rewrite*

Browse source
This commit is contained in:
sindrekjelsrud 2023-07-19 21:31:30 +02:00
parent ffd4d5e86c
commit 2ba37bfbe3
8658 changed files with 2268794 additions and 2538 deletions
Download patch file Download diff file Expand all files Collapse all files

90
node_modules/mdast-util-from-markdown/dev/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,90 @@
import type {OnEnterError} from './lib/index.js'
export type {
CompileContext,
Encoding,
Extension,
Handle,
OnEnterError,
OnExitError,
Options,
Token,
Transform,
Value
} from './lib/index.js'
/**
* Deprecated: use `OnEnterError`.
*/
// To do: next major: remove.
export type OnError = OnEnterError
/**
* Interface of tracked data.
*
* When working on extensions that use more data, extend the corresponding
* interface to register their types:
*
* ```ts
* declare module 'mdast-util-from-markdown' {
* interface CompileData {
* // Register a new field.
* mathFlowInside?: boolean | undefined
* }
* }
* ```
*/
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface CompileData {
/**
* Whether we’re inside a hard break.
*/
atHardBreak?: boolean | undefined
/**
* Current character reference type.
*/
characterReferenceType?:
| 'characterReferenceMarkerHexadecimal'
| 'characterReferenceMarkerNumeric'
| undefined
/**
* Whether a first list item value (`1` in `1. a`) is expected.
*/
expectingFirstListItemValue?: boolean | undefined
/**
* Whether we’re in flow code.
*/
flowCodeInside?: boolean | undefined
/**
* Whether we’re in a reference.
*/
inReference?: boolean | undefined
/**
* Whether we’re expecting a line ending from a setext heading, which can be slurped.
*/
setextHeadingSlurpLineEnding?: boolean | undefined
/**
* Current reference.
*/
referenceType?: 'collapsed' | 'full' | undefined
}
declare module 'micromark-util-types' {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
interface TokenTypeMap {
listItem: 'listItem'
}
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
interface Token {
_spread?: boolean
}
}
export {fromMarkdown} from './lib/index.js'

2
node_modules/mdast-util-from-markdown/dev/index.js generated vendored Normal file
View file

@ -0,0 +1,2 @@
// Note: types exported from `index.d.ts`.
export {fromMarkdown} from './lib/index.js'

184
node_modules/mdast-util-from-markdown/dev/lib/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,184 @@
/**
* @param value
* Markdown to parse.
* @param encoding
* Character encoding for when `value` is `Buffer`.
* @param options
* Configuration.
* @returns
* mdast tree.
*/
export const fromMarkdown: ((
value: Value,
encoding: Encoding,
options?: Options | null | undefined
) => Root) &
((value: Value, options?: Options | null | undefined) => Root)
export type Encoding = import('micromark-util-types').Encoding
export type Event = import('micromark-util-types').Event
export type ParseOptions = import('micromark-util-types').ParseOptions
export type Token = import('micromark-util-types').Token
export type TokenizeContext = import('micromark-util-types').TokenizeContext
export type Value = import('micromark-util-types').Value
export type UnistParent = import('unist').Parent
export type Point = import('unist').Point
export type PhrasingContent = import('mdast').PhrasingContent
export type StaticPhrasingContent = import('mdast').StaticPhrasingContent
export type Content = import('mdast').Content
export type Break = import('mdast').Break
export type Blockquote = import('mdast').Blockquote
export type Code = import('mdast').Code
export type Definition = import('mdast').Definition
export type Emphasis = import('mdast').Emphasis
export type Heading = import('mdast').Heading
export type HTML = import('mdast').HTML
export type Image = import('mdast').Image
export type ImageReference = import('mdast').ImageReference
export type InlineCode = import('mdast').InlineCode
export type Link = import('mdast').Link
export type LinkReference = import('mdast').LinkReference
export type List = import('mdast').List
export type ListItem = import('mdast').ListItem
export type Paragraph = import('mdast').Paragraph
export type Root = import('mdast').Root
export type Strong = import('mdast').Strong
export type Text = import('mdast').Text
export type ThematicBreak = import('mdast').ThematicBreak
export type ReferenceType = import('mdast').ReferenceType
export type CompileData = import('../index.js').CompileData
export type Node = Root | Content
export type Parent = Extract<Node, UnistParent>
export type Fragment = Omit<UnistParent, 'type' | 'children'> & {
type: 'fragment'
children: Array<PhrasingContent>
}
/**
* Extra transform, to change the AST afterwards.
*/
export type Transform = (tree: Root) => Root | undefined | null | void
/**
* Handle a token.
*/
export type Handle = (this: CompileContext, token: Token) => void
/**
* Token types mapping to handles
*/
export type Handles = Record<string, Handle>
/**
* Handle the case where the `right` token is open, but it is closed (by the
* `left` token) or because we reached the end of the document.
*/
export type OnEnterError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token | undefined,
right: Token
) => void
/**
* Handle the case where the `right` token is open but it is closed by
* exiting the `left` token.
*/
export type OnExitError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token,
right: Token
) => void
/**
* Open token on the stack, with an optional error handler for when
* that token isn’t closed properly.
*/
export type TokenTuple = [Token, OnEnterError | undefined]
/**
* Configuration.
*
* We have our defaults, but extensions will add more.
*/
export type Config = {
/**
* Token types where line endings are used.
*/
canContainEols: Array<string>
/**
* Opening handles.
*/
enter: Handles
/**
* Closing handles.
*/
exit: Handles
/**
* Tree transforms.
*/
transforms: Array<Transform>
}
/**
* Change how markdown tokens from micromark are turned into mdast.
*/
export type Extension = Partial<Config>
/**
* mdast compiler context.
*/
export type CompileContext = {
/**
* Stack of nodes.
*/
stack: Array<Node | Fragment>
/**
* Stack of tokens.
*/
tokenStack: Array<TokenTuple>
/**
* Get data from the key/value store.
*/
getData: <Key extends keyof import('../index.js').CompileData>(
key: Key
) => import('../index.js').CompileData[Key]
/**
* Set data into the key/value store.
*/
setData: <Key_1 extends keyof import('../index.js').CompileData>(
key: Key_1,
value?: import('../index.js').CompileData[Key_1] | undefined
) => void
/**
* Capture some of the output data.
*/
buffer: (this: CompileContext) => void
/**
* Stop capturing and access the output data.
*/
resume: (this: CompileContext) => string
/**
* Enter a token.
*/
enter: <Kind extends Node>(
this: CompileContext,
node: Kind,
token: Token,
onError?: OnEnterError
) => Kind
/**
* Exit a token.
*/
exit: (this: CompileContext, token: Token, onError?: OnExitError) => Node
/**
* Get the string value of a token.
*/
sliceSerialize: TokenizeContext['sliceSerialize']
/**
* Configuration.
*/
config: Config
}
/**
* Configuration for how to build mdast.
*/
export type FromMarkdownOptions = {
/**
* Extensions for this utility to change how tokens are turned into a tree.
*/
mdastExtensions?: Array<Extension | Array<Extension>> | null | undefined
}
/**
* Configuration.
*/
export type Options = ParseOptions & FromMarkdownOptions

1464
node_modules/mdast-util-from-markdown/dev/lib/index.js generated vendored Normal file
View file

File diff suppressed because it is too large Load diff

90
node_modules/mdast-util-from-markdown/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,90 @@
import type {OnEnterError} from './lib/index.js'
export type {
CompileContext,
Encoding,
Extension,
Handle,
OnEnterError,
OnExitError,
Options,
Token,
Transform,
Value
} from './lib/index.js'
/**
* Deprecated: use `OnEnterError`.
*/
// To do: next major: remove.
export type OnError = OnEnterError
/**
* Interface of tracked data.
*
* When working on extensions that use more data, extend the corresponding
* interface to register their types:
*
* ```ts
* declare module 'mdast-util-from-markdown' {
* interface CompileData {
* // Register a new field.
* mathFlowInside?: boolean | undefined
* }
* }
* ```
*/
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
export interface CompileData {
/**
* Whether we’re inside a hard break.
*/
atHardBreak?: boolean | undefined
/**
* Current character reference type.
*/
characterReferenceType?:
| 'characterReferenceMarkerHexadecimal'
| 'characterReferenceMarkerNumeric'
| undefined
/**
* Whether a first list item value (`1` in `1. a`) is expected.
*/
expectingFirstListItemValue?: boolean | undefined
/**
* Whether we’re in flow code.
*/
flowCodeInside?: boolean | undefined
/**
* Whether we’re in a reference.
*/
inReference?: boolean | undefined
/**
* Whether we’re expecting a line ending from a setext heading, which can be slurped.
*/
setextHeadingSlurpLineEnding?: boolean | undefined
/**
* Current reference.
*/
referenceType?: 'collapsed' | 'full' | undefined
}
declare module 'micromark-util-types' {
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
interface TokenTypeMap {
listItem: 'listItem'
}
// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
interface Token {
_spread?: boolean
}
}
export {fromMarkdown} from './lib/index.js'

2
node_modules/mdast-util-from-markdown/index.js generated vendored Normal file
View file

@ -0,0 +1,2 @@
// Note: types exported from `index.d.ts`.
export {fromMarkdown} from './lib/index.js'

184
node_modules/mdast-util-from-markdown/lib/index.d.ts generated vendored Normal file
View file

@ -0,0 +1,184 @@
/**
* @param value
* Markdown to parse.
* @param encoding
* Character encoding for when `value` is `Buffer`.
* @param options
* Configuration.
* @returns
* mdast tree.
*/
export const fromMarkdown: ((
value: Value,
encoding: Encoding,
options?: Options | null | undefined
) => Root) &
((value: Value, options?: Options | null | undefined) => Root)
export type Encoding = import('micromark-util-types').Encoding
export type Event = import('micromark-util-types').Event
export type ParseOptions = import('micromark-util-types').ParseOptions
export type Token = import('micromark-util-types').Token
export type TokenizeContext = import('micromark-util-types').TokenizeContext
export type Value = import('micromark-util-types').Value
export type UnistParent = import('unist').Parent
export type Point = import('unist').Point
export type PhrasingContent = import('mdast').PhrasingContent
export type StaticPhrasingContent = import('mdast').StaticPhrasingContent
export type Content = import('mdast').Content
export type Break = import('mdast').Break
export type Blockquote = import('mdast').Blockquote
export type Code = import('mdast').Code
export type Definition = import('mdast').Definition
export type Emphasis = import('mdast').Emphasis
export type Heading = import('mdast').Heading
export type HTML = import('mdast').HTML
export type Image = import('mdast').Image
export type ImageReference = import('mdast').ImageReference
export type InlineCode = import('mdast').InlineCode
export type Link = import('mdast').Link
export type LinkReference = import('mdast').LinkReference
export type List = import('mdast').List
export type ListItem = import('mdast').ListItem
export type Paragraph = import('mdast').Paragraph
export type Root = import('mdast').Root
export type Strong = import('mdast').Strong
export type Text = import('mdast').Text
export type ThematicBreak = import('mdast').ThematicBreak
export type ReferenceType = import('mdast').ReferenceType
export type CompileData = import('../index.js').CompileData
export type Node = Root | Content
export type Parent = Extract<Node, UnistParent>
export type Fragment = Omit<UnistParent, 'type' | 'children'> & {
type: 'fragment'
children: Array<PhrasingContent>
}
/**
* Extra transform, to change the AST afterwards.
*/
export type Transform = (tree: Root) => Root | undefined | null | void
/**
* Handle a token.
*/
export type Handle = (this: CompileContext, token: Token) => void
/**
* Token types mapping to handles
*/
export type Handles = Record<string, Handle>
/**
* Handle the case where the `right` token is open, but it is closed (by the
* `left` token) or because we reached the end of the document.
*/
export type OnEnterError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token | undefined,
right: Token
) => void
/**
* Handle the case where the `right` token is open but it is closed by
* exiting the `left` token.
*/
export type OnExitError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token,
right: Token
) => void
/**
* Open token on the stack, with an optional error handler for when
* that token isn’t closed properly.
*/
export type TokenTuple = [Token, OnEnterError | undefined]
/**
* Configuration.
*
* We have our defaults, but extensions will add more.
*/
export type Config = {
/**
* Token types where line endings are used.
*/
canContainEols: Array<string>
/**
* Opening handles.
*/
enter: Handles
/**
* Closing handles.
*/
exit: Handles
/**
* Tree transforms.
*/
transforms: Array<Transform>
}
/**
* Change how markdown tokens from micromark are turned into mdast.
*/
export type Extension = Partial<Config>
/**
* mdast compiler context.
*/
export type CompileContext = {
/**
* Stack of nodes.
*/
stack: Array<Node | Fragment>
/**
* Stack of tokens.
*/
tokenStack: Array<TokenTuple>
/**
* Get data from the key/value store.
*/
getData: <Key extends keyof import('../index.js').CompileData>(
key: Key
) => import('../index.js').CompileData[Key]
/**
* Set data into the key/value store.
*/
setData: <Key_1 extends keyof import('../index.js').CompileData>(
key: Key_1,
value?: import('../index.js').CompileData[Key_1] | undefined
) => void
/**
* Capture some of the output data.
*/
buffer: (this: CompileContext) => void
/**
* Stop capturing and access the output data.
*/
resume: (this: CompileContext) => string
/**
* Enter a token.
*/
enter: <Kind extends Node>(
this: CompileContext,
node: Kind,
token: Token,
onError?: OnEnterError
) => Kind
/**
* Exit a token.
*/
exit: (this: CompileContext, token: Token, onError?: OnExitError) => Node
/**
* Get the string value of a token.
*/
sliceSerialize: TokenizeContext['sliceSerialize']
/**
* Configuration.
*/
config: Config
}
/**
* Configuration for how to build mdast.
*/
export type FromMarkdownOptions = {
/**
* Extensions for this utility to change how tokens are turned into a tree.
*/
mdastExtensions?: Array<Extension | Array<Extension>> | null | undefined
}
/**
* Configuration.
*/
export type Options = ParseOptions & FromMarkdownOptions

1383
node_modules/mdast-util-from-markdown/lib/index.js generated vendored Normal file
View file

File diff suppressed because it is too large Load diff

22
node_modules/mdast-util-from-markdown/license generated vendored Normal file
View file

@ -0,0 +1,22 @@
(The MIT License)
Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

1
node_modules/mdast-util-from-markdown/node_modules/.bin/uvu generated vendored Symbolic link
View file

@ -0,0 +1 @@
../../../uvu/bin.js

120
node_modules/mdast-util-from-markdown/package.json generated vendored Normal file
View file

@ -0,0 +1,120 @@
{
"name": "mdast-util-from-markdown",
"version": "1.3.1",
"description": "mdast utility to parse markdown",
"license": "MIT",
"keywords": [
"unist",
"mdast",
"mdast-util",
"util",
"utility",
"markdown",
"markup",
"parse",
"syntax",
"tree",
"ast"
],
"repository": "syntax-tree/mdast-util-from-markdown",
"bugs": "https://github.com/syntax-tree/mdast-util-from-markdown/issues",
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
],
"sideEffects": false,
"type": "module",
"main": "index.js",
"types": "index.d.ts",
"files": [
"dev/",
"lib/",
"index.d.ts",
"index.js"
],
"exports": {
"development": "./dev/index.js",
"default": "./index.js"
},
"dependencies": {
"@types/mdast": "^3.0.0",
"@types/unist": "^2.0.0",
"decode-named-character-reference": "^1.0.0",
"mdast-util-to-string": "^3.1.0",
"micromark": "^3.0.0",
"micromark-util-decode-numeric-character-reference": "^1.0.0",
"micromark-util-decode-string": "^1.0.0",
"micromark-util-normalize-identifier": "^1.0.0",
"micromark-util-symbol": "^1.0.0",
"micromark-util-types": "^1.0.0",
"unist-util-stringify-position": "^3.0.0",
"uvu": "^0.5.0"
},
"devDependencies": {
"@types/node": "^20.0.0",
"c8": "^7.0.0",
"commonmark.json": "^0.30.0",
"esbuild": "^0.17.0",
"gzip-size-cli": "^5.0.0",
"hast-util-from-html": "^1.0.0",
"hast-util-to-html": "^8.0.0",
"mdast-util-to-hast": "^12.0.0",
"micromark-build": "^1.0.0",
"prettier": "^2.0.0",
"remark-cli": "^11.0.0",
"remark-preset-wooorm": "^9.0.0",
"terser": "^5.0.0",
"type-coverage": "^2.0.0",
"typescript": "^5.0.0",
"xo": "^0.54.0"
},
"scripts": {
"prepack": "npm run build && npm run format",
"build": "tsc --build --clean && tsc --build && type-coverage && micromark-build && esbuild . --bundle --minify | terser | gzip-size --raw",
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
"test-api": "node --conditions development test/index.js",
"test-coverage": "c8 --check-coverage --100 --reporter lcov npm run test-api",
"test": "npm run build && npm run format && npm run test-coverage"
},
"prettier": {
"tabWidth": 2,
"useTabs": false,
"singleQuote": true,
"bracketSpacing": false,
"semi": false,
"trailingComma": "none"
},
"xo": {
"prettier": true,
"rules": {
"complexity": "off",
"n/file-extension-in-import": "off",
"unicorn/prefer-code-point": "off",
"unicorn/prefer-switch": "off",
"unicorn/prefer-node-protocol": "off"
},
"overrides": [
{
"files": "test/**/*.js",
"rules": {
"no-await-in-loop": "off"
}
}
]
},
"remarkConfig": {
"plugins": [
"preset-wooorm"
]
},
"typeCoverage": {
"atLeast": 100,
"detail": true,
"strict": true,
"ignoreCatch": true
}
}

544
node_modules/mdast-util-from-markdown/readme.md generated vendored Normal file
View file

@ -0,0 +1,544 @@
# mdast-util-from-markdown
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[mdast][]** utility that turns markdown into a syntax tree.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`fromMarkdown(value[, encoding][, options])`](#frommarkdownvalue-encoding-options)
* [`CompileContext`](#compilecontext)
* [`CompileData`](#compiledata)
* [`Encoding`](#encoding)
* [`Extension`](#extension)
* [`Handle`](#handle)
* [`OnEnterError`](#onentererror)
* [`OnExitError`](#onexiterror)
* [`Options`](#options)
* [`Token`](#token)
* [`Transform`](#transform)
* [`Value`](#value)
* [List of extensions](#list-of-extensions)
* [Syntax](#syntax)
* [Syntax tree](#syntax-tree)
* [Types](#types)
* [Compatibility](#compatibility)
* [Security](#security)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a utility that takes markdown input and turns it into an
[mdast][] syntax tree.
This utility uses [`micromark`][micromark], which turns markdown into tokens,
and then turns those tokens into nodes.
This package is used inside [`remark-parse`][remark-parse], which focusses on
making it easier to transform content by abstracting these internals away.
## When should I use this?
If you want to handle syntax trees manually, use this.
When you *just* want to turn markdown into HTML, use [`micromark`][micromark]
instead.
For an easier time processing content, use the **[remark][]** ecosystem instead.
You can combine this package with other packages to add syntax extensions to
markdown.
Notable examples that deeply integrate with this package are
[`mdast-util-gfm`][mdast-util-gfm],
[`mdast-util-mdx`][mdast-util-mdx],
[`mdast-util-frontmatter`][mdast-util-frontmatter],
[`mdast-util-math`][mdast-util-math], and
[`mdast-util-directive`][mdast-util-directive].
## Install
This package is [ESM only][esm].
In Node.js (version 14.14+ and 16.0+), install with [npm][]:
```sh
npm install mdast-util-from-markdown
```
In Deno with [`esm.sh`][esmsh]:
```js
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@1'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@1?bundle'
</script>
```
## Use
Say we have the following markdown file `example.md`:
```markdown
## Hello, *World*!
```
…and our module `example.js` looks as follows:
```js
import fs from 'node:fs/promises'
import {fromMarkdown} from 'mdast-util-from-markdown'
const doc = await fs.readFile('example.md')
const tree = fromMarkdown(doc)
console.log(tree)
```
…now running `node example.js` yields (positional info removed for brevity):
```js
{
type: 'root',
children: [
{
type: 'heading',
depth: 2,
children: [
{type: 'text', value: 'Hello, '},
{type: 'emphasis', children: [{type: 'text', value: 'World'}]},
{type: 'text', value: '!'}
]
}
]
}
```
## API
This package exports the identifier [`fromMarkdown`][api-frommarkdown].
There is no default export.
The export map supports the [`development` condition][development].
Run `node --conditions development example.js` to get instrumented dev code.
Without this condition, production code is loaded.
### `fromMarkdown(value[, encoding][, options])`
Turn markdown into a syntax tree.
###### Overloads
* `(value: Value, encoding: Encoding, options?: Options) => Root`
* `(value: Value, options?: Options) => Root`
###### Parameters
* `value` ([`Value`][api-value])
— markdown to parse
* `encoding` ([`Encoding`][api-encoding], default: `'utf8'`)
— [character encoding][character-encoding] for when `value` is
[`Buffer`][buffer]
* `options` ([`Options`][api-options], optional)
— configuration
###### Returns
mdast tree ([`Root`][root]).
### `CompileContext`
mdast compiler context (TypeScript type).
###### Fields
* `stack` ([`Array<Node>`][node])
— stack of nodes
* `tokenStack` (`Array<[Token, OnEnterError | undefined]>`)
— stack of tokens
* `getData` (`(key: string) => unknown`)
— get data from the key/value store (see [`CompileData`][api-compiledata])
* `setData` (`(key: string, value?: unknown) => void`)
— set data into the key/value store (see [`CompileData`][api-compiledata])
* `buffer` (`() => void`)
— capture some of the output data
* `resume` (`() => string`)
— stop capturing and access the output data
* `enter` (`(node: Node, token: Token, onError?: OnEnterError) => Node`)
— enter a token
* `exit` (`(token: Token, onError?: OnExitError) => Node`)
— exit a token
* `sliceSerialize` (`(token: Token, expandTabs?: boolean) => string`)
— get the string value of a token
* `config` (`Required<Extension>`)
— configuration
### `CompileData`
Interface of tracked data (TypeScript type).
###### Type
```ts
interface CompileData { /* see code */ }
```
When working on extensions that use more data, extend the corresponding
interface to register their types:
```ts
declare module 'mdast-util-from-markdown' {
interface CompileData {
// Register a new field.
mathFlowInside?: boolean | undefined
}
}
```
### `Encoding`
Encodings supported by the [`Buffer`][buffer] class (TypeScript type).
<!-- To do: link to micromark type, when documented. -->
See [`micromark`](https://github.com/micromark/micromark#api) for more info.
###### Type
```ts
type Encoding = 'utf8' | /* … */
```
### `Extension`
Change how markdown tokens from micromark are turned into mdast (TypeScript
type).
###### Properties
* `canContainEols` (`Array<string>`, optional)
— token types where line endings are used
* `enter` ([`Record<string, Handle>`][api-handle], optional)
— opening handles
* `exit` ([`Record<string, Handle>`][api-handle], optional)
— closing handles
* `transforms` ([`Array<Transform>`][api-transform], optional)
— tree transforms
### `Handle`
Handle a token (TypeScript type).
###### Parameters
* `this` ([`CompileContext`][api-compilecontext])
— context
* `token` ([`Token`][api-token])
— current token
###### Returns
Nothing (`void`).
### `OnEnterError`
Handle the case where the `right` token is open, but it is closed (by the
`left` token) or because we reached the end of the document (TypeScript type).
###### Parameters
* `this` ([`CompileContext`][api-compilecontext])
— context
* `left` ([`Token`][api-token] or `undefined`)
— left token
* `right` ([`Token`][api-token])
— right token
###### Returns
Nothing (`void`).
### `OnExitError`
Handle the case where the `right` token is open but it is closed by
exiting the `left` token (TypeScript type).
###### Parameters
* `this` ([`CompileContext`][api-compilecontext])
— context
* `left` ([`Token`][api-token])
— left token
* `right` ([`Token`][api-token])
— right token
###### Returns
Nothing (`void`).
### `Options`
Configuration (TypeScript type).
###### Properties
* `extensions` ([`Array<MicromarkExtension>`][micromark-extension], optional)
— micromark extensions to change how markdown is parsed
* `mdastExtensions` ([`Array<Extension | Array<Extension>>`][api-extension],
optional)
— extensions for this utility to change how tokens are turned into a tree
### `Token`
Token from micromark (TypeScript type).
<!-- To do: link to micromark type, when documented. -->
See [`micromark`](https://github.com/micromark/micromark#api) for more info.
###### Type
```ts
type Token = { /* … */ }
```
### `Transform`
Extra transform, to change the AST afterwards (TypeScript type).
###### Parameters
* `tree` ([`Root`][root])
— tree to transform
###### Returns
New tree ([`Root`][root]) or nothing (in which case the current tree is used).
### `Value`
Contents of the file (TypeScript type).
<!-- To do: link to micromark type, when documented. -->
See [`micromark`](https://github.com/micromark/micromark#api) for more info.
###### Type
```ts
type Value = string | Uint8Array
```
## List of extensions
* [`syntax-tree/mdast-util-directive`](https://github.com/syntax-tree/mdast-util-directive)
— directives
* [`syntax-tree/mdast-util-frontmatter`](https://github.com/syntax-tree/mdast-util-frontmatter)
— frontmatter (YAML, TOML, more)
* [`syntax-tree/mdast-util-gfm`](https://github.com/syntax-tree/mdast-util-gfm)
— GFM
* [`syntax-tree/mdast-util-gfm-autolink-literal`](https://github.com/syntax-tree/mdast-util-gfm-autolink-literal)
— GFM autolink literals
* [`syntax-tree/mdast-util-gfm-footnote`](https://github.com/syntax-tree/mdast-util-gfm-footnote)
— GFM footnotes
* [`syntax-tree/mdast-util-gfm-strikethrough`](https://github.com/syntax-tree/mdast-util-gfm-strikethrough)
— GFM strikethrough
* [`syntax-tree/mdast-util-gfm-table`](https://github.com/syntax-tree/mdast-util-gfm-table)
— GFM tables
* [`syntax-tree/mdast-util-gfm-task-list-item`](https://github.com/syntax-tree/mdast-util-gfm-task-list-item)
— GFM task list items
* [`syntax-tree/mdast-util-math`](https://github.com/syntax-tree/mdast-util-math)
— math
* [`syntax-tree/mdast-util-mdx`](https://github.com/syntax-tree/mdast-util-mdx)
— MDX
* [`syntax-tree/mdast-util-mdx-expression`](https://github.com/syntax-tree/mdast-util-mdx-expression)
— MDX expressions
* [`syntax-tree/mdast-util-mdx-jsx`](https://github.com/syntax-tree/mdast-util-mdx-jsx)
— MDX JSX
* [`syntax-tree/mdast-util-mdxjs-esm`](https://github.com/syntax-tree/mdast-util-mdxjs-esm)
— MDX ESM
## Syntax
Markdown is parsed according to CommonMark.
Extensions can add support for other syntax.
If you’re interested in extending markdown,
[more information is available in micromark’s readme][micromark-extend].
## Syntax tree
The syntax tree is [mdast][].
## Types
This package is fully typed with [TypeScript][].
It exports the additional types [`CompileContext`][api-compilecontext],
[`CompileData`][api-compiledata],
[`Encoding`][api-encoding],
[`Extension`][api-extension],
[`Handle`][api-handle],
[`OnEnterError`][api-onentererror],
[`OnExitError`][api-onexiterror],
[`Options`][api-options],
[`Token`][api-token],
[`Transform`][api-transform], and
[`Value`][api-value].
## Compatibility
Projects maintained by the unified collective are compatible with all maintained
versions of Node.js.
As of now, that is Node.js 14.14+ and 16.0+.
Our projects sometimes work with older versions, but this is not guaranteed.
## Security
As markdown is sometimes used for HTML, and improper use of HTML can open you up
to a [cross-site scripting (XSS)][xss] attack, use of `mdast-util-from-markdown`
can also be unsafe.
When going to HTML, use this utility in combination with
[`hast-util-sanitize`][hast-util-sanitize] to make the tree safe.
## Related
* [`syntax-tree/mdast-util-to-markdown`](https://github.com/syntax-tree/mdast-util-to-markdown)
— serialize mdast as markdown
* [`micromark/micromark`](https://github.com/micromark/micromark)
— parse markdown
* [`remarkjs/remark`](https://github.com/remarkjs/remark)
— process markdown
## Contribute
See [`contributing.md`][contributing] in [`syntax-tree/.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, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
<!-- Definitions -->
[build-badge]: https://github.com/syntax-tree/mdast-util-from-markdown/workflows/main/badge.svg
[build]: https://github.com/syntax-tree/mdast-util-from-markdown/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-from-markdown.svg
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-from-markdown
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-from-markdown.svg
[downloads]: https://www.npmjs.com/package/mdast-util-from-markdown
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-from-markdown.svg
[size]: https://bundlephobia.com/result?p=mdast-util-from-markdown
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/syntax-tree/unist/discussions
[npm]: https://docs.npmjs.com/cli/install
[esmsh]: https://esm.sh
[license]: license
[author]: https://wooorm.com
[health]: https://github.com/syntax-tree/.github
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[typescript]: https://www.typescriptlang.org
[mdast]: https://github.com/syntax-tree/mdast
[node]: https://github.com/syntax-tree/mdast#nodes
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
[mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
[mdast-util-frontmatter]: https://github.com/syntax-tree/mdast-util-frontmatter
[mdast-util-math]: https://github.com/syntax-tree/mdast-util-math
[mdast-util-directive]: https://github.com/syntax-tree/mdast-util-directive
[root]: https://github.com/syntax-tree/mdast#root
[character-encoding]: https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
[buffer]: https://nodejs.org/api/buffer.html
[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
[hast-util-sanitize]: https://github.com/syntax-tree/hast-util-sanitize
[micromark]: https://github.com/micromark/micromark
[micromark-extension]: https://github.com/micromark/micromark#optionsextensions
[micromark-extend]: https://github.com/micromark/micromark#extensions
[remark]: https://github.com/remarkjs/remark
[remark-parse]: https://github.com/remarkjs/remark/tree/main/packages/remark-parse
[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions
[api-frommarkdown]: #frommarkdownvalue-encoding-options
[api-compilecontext]: #compilecontext
[api-compiledata]: #compiledata
[api-encoding]: #encoding
[api-extension]: #extension
[api-handle]: #handle
[api-onentererror]: #onentererror
[api-onexiterror]: #onexiterror
[api-options]: #options
[api-token]: #token
[api-transform]: #transform
[api-value]: #value