Refactor routing in App component to enhance navigation and improve error handling by integrating dynamic routes and updating the NotFound route.

This commit is contained in:
becarta
2025-05-23 12:43:00 +02:00
parent f40db0f5c9
commit a544759a3b
11127 changed files with 1647032 additions and 0 deletions

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

@@ -0,0 +1,23 @@
export type {Encoding, Token, Value} from 'micromark-util-types'
export type {
CompileContext,
CompileData,
Extension,
Handles,
Handle,
OnEnterError,
OnExitError,
Options,
Transform
} from './lib/types.js'
export {fromMarkdown} from './lib/index.js'
declare module 'micromark-util-types' {
interface TokenTypeMap {
listItem: 'listItem'
}
interface Token {
_spread?: boolean
}
}

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'

View File

@@ -0,0 +1,53 @@
/**
* Turn markdown into a syntax tree.
*
* @overload
* @param {Value} value
* @param {Encoding | null | undefined} [encoding]
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @overload
* @param {Value} value
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @param {Value} value
* Markdown to parse.
* @param {Encoding | Options | null | undefined} [encoding]
* Character encoding for when `value` is `Buffer`.
* @param {Options | null | undefined} [options]
* Configuration.
* @returns {Root}
* mdast tree.
*/
export function fromMarkdown(value: Value, encoding?: Encoding | null | undefined, options?: Options | null | undefined): Root;
/**
* Turn markdown into a syntax tree.
*
* @overload
* @param {Value} value
* @param {Encoding | null | undefined} [encoding]
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @overload
* @param {Value} value
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @param {Value} value
* Markdown to parse.
* @param {Encoding | Options | null | undefined} [encoding]
* Character encoding for when `value` is `Buffer`.
* @param {Options | null | undefined} [options]
* Configuration.
* @returns {Root}
* mdast tree.
*/
export function fromMarkdown(value: Value, options?: Options | null | undefined): Root;
import type { Value } from 'micromark-util-types';
import type { Encoding } from 'micromark-util-types';
import type { Options } from './types.js';
import type { Root } from 'mdast';
//# sourceMappingURL=index.d.ts.map

View File

@@ -0,0 +1 @@
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAwDG,oCACQ,KAAK,aACL,QAAQ,GAAG,IAAI,GAAG,SAAS,YAC3B,OAAO,GAAG,IAAI,GAAG,SAAS,GACxB,IAAI,CAEd;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oCACQ,KAAK,YACL,OAAO,GAAG,IAAI,GAAG,SAAS,GACxB,IAAI,CAEd;2BAvCO,sBAAsB;8BAAtB,sBAAsB;6BAUtB,YAAY;0BAhBZ,OAAO"}

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

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,295 @@
import type {Nodes, Parent, PhrasingContent, Root} from 'mdast'
import type {ParseOptions, Token} from 'micromark-util-types'
/**
* Compiler context.
*/
export interface CompileContext {
/**
* Configuration.
*/
config: Config
/**
* Info passed around;
* key/value store.
*/
data: CompileData
/**
* Stack of nodes.
*/
stack: Array<Fragment | Nodes>
/**
* Stack of tokens.
*/
tokenStack: Array<TokenTuple>
/**
* Capture some of the output data.
*
* @param this
* Context.
* @returns
* Nothing.
*/
buffer(this: CompileContext): undefined
/**
* Enter a node.
*
* @param this
* Context.
* @param node
* Node.
* @param token
* Token.
* @param onError
* Error handler.
* @returns
* Nothing.
*/
enter(
this: CompileContext,
node: Nodes,
token: Token,
onError?: OnEnterError | null | undefined
): undefined
/**
* Exit a node.
*
* @param this
* Context.
* @param token
* Token.
* @param onError
* Error handler.
* @returns
* Nothing.
*/
exit(
this: CompileContext,
token: Token,
onError?: OnExitError | null | undefined
): undefined
/**
* Stop capturing and access the output data.
*
* @param this
* Context.
* @returns
* Nothing.
*/
resume(this: CompileContext): string
/**
* Get the source text that spans a token (or location).
*
* @param token
* Start/end in stream.
* @param expandTabs
* Whether to expand tabs.
* @returns
* Serialized chunks.
*/
sliceSerialize(
token: Pick<Token, 'end' | 'start'>,
expandTabs?: boolean | undefined
): string
}
/**
* 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
* }
* }
* ```
*/
export interface CompileData {
/**
* Whether were 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 were in flow code.
*/
flowCodeInside?: boolean | undefined
/**
* Whether were in a reference.
*/
inReference?: boolean | undefined
/**
* Whether were expecting a line ending from a setext heading, which can be slurped.
*/
setextHeadingSlurpLineEnding?: boolean | undefined
/**
* Current reference.
*/
referenceType?: 'collapsed' | 'full' | undefined
}
/**
* Configuration.
*
* We have our defaults, but extensions will add more.
*/
export interface 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 interface Extension {
/**
* Token types where line endings are used.
*/
canContainEols?: Array<string> | null | undefined
/**
* Opening handles.
*/
enter?: Handles | null | undefined
/**
* Closing handles.
*/
exit?: Handles | null | undefined
/**
* Tree transforms.
*/
transforms?: Array<Transform> | null | undefined
}
/**
* Internal fragment.
*/
export interface Fragment extends Parent {
/**
* Node type.
*/
type: 'fragment'
/**
* Children.
*/
children: Array<PhrasingContent>
}
/**
* Token types mapping to handles
*/
export type Handles = Record<string, Handle>
/**
* Handle a token.
*
* @param this
* Context.
* @param token
* Current token.
* @returns
* Nothing.
*/
export type Handle = (this: CompileContext, token: Token) => undefined | void
/**
* 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.
*
* @param this
* Context.
* @param left
* Left token.
* @param right
* Right token.
* @returns
* Nothing.
*/
export type OnEnterError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token | undefined,
right: Token
) => undefined
/**
* Handle the case where the `right` token is open but it is closed by
* exiting the `left` token.
*
* @param this
* Context.
* @param left
* Left token.
* @param right
* Right token.
* @returns
* Nothing.
*/
export type OnExitError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token,
right: Token
) => undefined
/**
* Configuration.
*/
export interface Options extends ParseOptions {
/**
* Extensions for this utility to change how tokens are turned into a tree.
*/
mdastExtensions?: Array<Extension | Array<Extension>> | null | undefined
}
/**
* Open token on the stack,
* with an optional error handler for when that token isnt closed properly.
*/
export type TokenTuple = [token: Token, onError: OnEnterError | undefined]
/**
* Extra transform, to change the AST afterwards.
*
* @param tree
* Tree to transform.
* @returns
* New tree or nothing (in which case the current tree is used).
*/
export type Transform = (tree: Root) => Root | null | undefined | void

View File

@@ -0,0 +1,2 @@
// Note: types exposed from `types.d.ts`.
export {}

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

@@ -0,0 +1,23 @@
export type {Encoding, Token, Value} from 'micromark-util-types'
export type {
CompileContext,
CompileData,
Extension,
Handles,
Handle,
OnEnterError,
OnExitError,
Options,
Transform
} from './lib/types.js'
export {fromMarkdown} from './lib/index.js'
declare module 'micromark-util-types' {
interface TokenTypeMap {
listItem: 'listItem'
}
interface Token {
_spread?: boolean
}
}

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';

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

@@ -0,0 +1,53 @@
/**
* Turn markdown into a syntax tree.
*
* @overload
* @param {Value} value
* @param {Encoding | null | undefined} [encoding]
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @overload
* @param {Value} value
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @param {Value} value
* Markdown to parse.
* @param {Encoding | Options | null | undefined} [encoding]
* Character encoding for when `value` is `Buffer`.
* @param {Options | null | undefined} [options]
* Configuration.
* @returns {Root}
* mdast tree.
*/
export function fromMarkdown(value: Value, encoding?: Encoding | null | undefined, options?: Options | null | undefined): Root;
/**
* Turn markdown into a syntax tree.
*
* @overload
* @param {Value} value
* @param {Encoding | null | undefined} [encoding]
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @overload
* @param {Value} value
* @param {Options | null | undefined} [options]
* @returns {Root}
*
* @param {Value} value
* Markdown to parse.
* @param {Encoding | Options | null | undefined} [encoding]
* Character encoding for when `value` is `Buffer`.
* @param {Options | null | undefined} [options]
* Configuration.
* @returns {Root}
* mdast tree.
*/
export function fromMarkdown(value: Value, options?: Options | null | undefined): Root;
import type { Value } from 'micromark-util-types';
import type { Encoding } from 'micromark-util-types';
import type { Options } from './types.js';
import type { Root } from 'mdast';
//# sourceMappingURL=index.d.ts.map

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

File diff suppressed because it is too large Load Diff

295
node_modules/mdast-util-from-markdown/lib/types.d.ts generated vendored Normal file
View File

@@ -0,0 +1,295 @@
import type {Nodes, Parent, PhrasingContent, Root} from 'mdast'
import type {ParseOptions, TokenizeContext, Token} from 'micromark-util-types'
/**
* Compiler context.
*/
export interface CompileContext {
/**
* Configuration.
*/
config: Config
/**
* Info passed around;
* key/value store.
*/
data: CompileData
/**
* Stack of nodes.
*/
stack: Array<Fragment | Nodes>
/**
* Stack of tokens.
*/
tokenStack: Array<TokenTuple>
/**
* Capture some of the output data.
*
* @param this
* Context.
* @returns
* Nothing.
*/
buffer(this: CompileContext): undefined
/**
* Enter a node.
*
* @param this
* Context.
* @param node
* Node.
* @param token
* Token.
* @param onError
* Error handler.
* @returns
* Nothing.
*/
enter(
this: CompileContext,
node: Nodes,
token: Token,
onError?: OnEnterError | null | undefined
): undefined
/**
* Exit a node.
*
* @param this
* Context.
* @param token
* Token.
* @param onError
* Error handler.
* @returns
* Nothing.
*/
exit(
this: CompileContext,
token: Token,
onError?: OnExitError | null | undefined
): undefined
/**
* Stop capturing and access the output data.
*
* @param this
* Context.
* @returns
* Nothing.
*/
resume(this: CompileContext): string
/**
* Get the source text that spans a token (or location).
*
* @param token
* Start/end in stream.
* @param expandTabs
* Whether to expand tabs.
* @returns
* Serialized chunks.
*/
sliceSerialize(
token: Pick<Token, 'end' | 'start'>,
expandTabs?: boolean | undefined
): string
}
/**
* 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
* }
* }
* ```
*/
export interface CompileData {
/**
* Whether were 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 were in flow code.
*/
flowCodeInside?: boolean | undefined
/**
* Whether were in a reference.
*/
inReference?: boolean | undefined
/**
* Whether were expecting a line ending from a setext heading, which can be slurped.
*/
setextHeadingSlurpLineEnding?: boolean | undefined
/**
* Current reference.
*/
referenceType?: 'collapsed' | 'full' | undefined
}
/**
* Configuration.
*
* We have our defaults, but extensions will add more.
*/
export interface 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 interface Extension {
/**
* Token types where line endings are used.
*/
canContainEols?: Array<string> | null | undefined
/**
* Opening handles.
*/
enter?: Handles | null | undefined
/**
* Closing handles.
*/
exit?: Handles | null | undefined
/**
* Tree transforms.
*/
transforms?: Array<Transform> | null | undefined
}
/**
* Internal fragment.
*/
export interface Fragment extends Parent {
/**
* Node type.
*/
type: 'fragment'
/**
* Children.
*/
children: Array<PhrasingContent>
}
/**
* Token types mapping to handles
*/
export type Handles = Record<string, Handle>
/**
* Handle a token.
*
* @param this
* Context.
* @param token
* Current token.
* @returns
* Nothing.
*/
export type Handle = (this: CompileContext, token: Token) => undefined | void
/**
* 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.
*
* @param this
* Context.
* @param left
* Left token.
* @param right
* Right token.
* @returns
* Nothing.
*/
export type OnEnterError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token | undefined,
right: Token
) => undefined
/**
* Handle the case where the `right` token is open but it is closed by
* exiting the `left` token.
*
* @param this
* Context.
* @param left
* Left token.
* @param right
* Right token.
* @returns
* Nothing.
*/
export type OnExitError = (
this: Omit<CompileContext, 'sliceSerialize'>,
left: Token,
right: Token
) => undefined
/**
* Configuration.
*/
export interface Options extends ParseOptions {
/**
* Extensions for this utility to change how tokens are turned into a tree.
*/
mdastExtensions?: Array<Extension | Array<Extension>> | null | undefined
}
/**
* Open token on the stack,
* with an optional error handler for when that token isnt closed properly.
*/
export type TokenTuple = [token: Token, onError: OnEnterError | undefined]
/**
* Extra transform, to change the AST afterwards.
*
* @param tree
* Tree to transform.
* @returns
* New tree or nothing (in which case the current tree is used).
*/
export type Transform = (tree: Root) => Root | null | undefined | void

2
node_modules/mdast-util-from-markdown/lib/types.js generated vendored Normal file
View File

@@ -0,0 +1,2 @@
// Note: types exposed from `types.d.ts`.
export {};

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

@@ -0,0 +1,22 @@
(The MIT License)
Copyright (c) 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.

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

@@ -0,0 +1,139 @@
{
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
"bugs": "https://github.com/syntax-tree/mdast-util-from-markdown/issues",
"contributors": [
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
],
"dependencies": {
"@types/mdast": "^4.0.0",
"@types/unist": "^3.0.0",
"decode-named-character-reference": "^1.0.0",
"devlop": "^1.0.0",
"mdast-util-to-string": "^4.0.0",
"micromark": "^4.0.0",
"micromark-util-decode-numeric-character-reference": "^2.0.0",
"micromark-util-decode-string": "^2.0.0",
"micromark-util-normalize-identifier": "^2.0.0",
"micromark-util-symbol": "^2.0.0",
"micromark-util-types": "^2.0.0",
"unist-util-stringify-position": "^4.0.0"
},
"description": "mdast utility to parse markdown",
"devDependencies": {
"@types/node": "^22.0.0",
"c8": "^10.0.0",
"commonmark.json": "^0.31.0",
"esbuild": "^0.24.0",
"gzip-size-cli": "^5.0.0",
"hast-util-from-html": "^2.0.0",
"hast-util-to-html": "^9.0.0",
"mdast-util-to-hast": "^13.0.0",
"micromark-build": "^2.0.0",
"prettier": "^3.0.0",
"remark-cli": "^12.0.0",
"remark-preset-wooorm": "^10.0.0",
"terser": "^5.0.0",
"type-coverage": "^2.0.0",
"typescript": "^5.0.0",
"xo": "^0.59.0"
},
"exports": {
"development": "./dev/index.js",
"default": "./index.js"
},
"files": [
"dev/",
"lib/",
"index.d.ts",
"index.js"
],
"funding": {
"type": "opencollective",
"url": "https://opencollective.com/unified"
},
"keywords": [
"ast",
"markdown",
"markup",
"mdast-util",
"mdast",
"parse",
"syntax",
"tree",
"unist",
"utility",
"util"
],
"license": "MIT",
"name": "mdast-util-from-markdown",
"prettier": {
"bracketSpacing": false,
"semi": false,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "none",
"useTabs": false
},
"remarkConfig": {
"plugins": [
"remark-preset-wooorm"
]
},
"repository": "syntax-tree/mdast-util-from-markdown",
"scripts": {
"build": "tsc --build --clean && tsc --build && type-coverage && micromark-build && esbuild . --bundle --minify | terser | gzip-size --raw",
"format": "remark --frail --quiet --output -- . && prettier --log-level warn --write -- . && xo --fix",
"test-api-dev": "node --conditions development test/index.js",
"test-api-prod": "node --conditions production test/index.js",
"test-api": "npm run test-api-dev && npm run test-api-prod",
"test-coverage": "c8 --100 --reporter lcov -- npm run test-api",
"test": "npm run build && npm run format && npm run test-coverage"
},
"sideEffects": false,
"typeCoverage": {
"atLeast": 100,
"strict": true
},
"type": "module",
"version": "2.0.2",
"xo": {
"overrides": [
{
"files": [
"**/*.d.ts"
],
"rules": {
"@typescript-eslint/array-type": [
"error",
{
"default": "generic"
}
],
"@typescript-eslint/ban-types": [
"error",
{
"extendDefaults": true
}
],
"@typescript-eslint/consistent-type-definitions": [
"error",
"interface"
]
}
},
{
"files": "test/**/*.js",
"rules": {
"no-await-in-loop": "off"
}
}
],
"prettier": true,
"rules": {
"complexity": "off",
"max-depth": "off",
"unicorn/prefer-at": "off",
"unicorn/prefer-string-replace-all": "off"
}
}
}

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

@@ -0,0 +1,537 @@
# 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 16+), 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@2'
```
In browsers with [`esm.sh`][esmsh]:
```html
<script type="module">
import {fromMarkdown} from 'https://esm.sh/mdast-util-from-markdown@2?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-from-markdown].
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][encoding] for when `value` is
[`Uint8Array`][uint8-array]
* `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
* `data` ([`CompileData`][api-compile-data])
— info passed around; key/value store
* `buffer` (`() => undefined`)
— capture some of the output data
* `resume` (`() => string`)
— stop capturing and access the output data
* `enter` (`(node: Node, token: Token, onError?: OnEnterError) => undefined`)
— enter a node
* `exit` (`(token: Token, onError?: OnExitError) => undefined`)
— exit a node
* `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 [`Uint8Array`][uint8-array] class (TypeScript type).
See [`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-compile-context])
— context
* `token` ([`Token`][api-token])
— current token
###### Returns
Nothing (`undefined`).
### `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-compile-context])
— context
* `left` ([`Token`][api-token] or `undefined`)
— left token
* `right` ([`Token`][api-token])
— right token
###### Returns
Nothing (`undefined`).
### `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-compile-context])
— context
* `left` ([`Token`][api-token])
— left token
* `right` ([`Token`][api-token])
— right token
###### Returns
Nothing (`undefined`).
### `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).
###### 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).
See [`micromark`][micromark-api] for more info.
###### Type
```ts
type Value = Uint8Array | string
```
## 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 youre interested in extending markdown,
[more information is available in micromarks readme][micromark-extension].
## Syntax tree
The syntax tree is [mdast][].
## Types
This package is fully typed with [TypeScript][].
It exports the additional types [`CompileContext`][api-compile-context],
[`CompileData`][api-compile-data],
[`Encoding`][api-encoding],
[`Extension`][api-extension],
[`Handle`][api-handle],
[`OnEnterError`][api-on-enter-error],
[`OnExitError`][api-on-exit-error],
[`Options`][api-options],
[`Token`][api-token],
[`Transform`][api-transform], and
[`Value`][api-value].
## Compatibility
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,
`mdast-util-from-markdown@^2`, compatible with Node.js 16.
## 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/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-from-markdown
[size]: https://bundlejs.com/?q=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
[uint8-array]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array
[encoding]: https://nodejs.org/api/util.html#whatwg-supported-encodings
[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-api]: https://github.com/micromark/micromark/tree/main/packages/micromark#micromarkvalue-encoding-options
[micromark-extension]: 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-from-markdown]: #frommarkdownvalue-encoding-options
[api-compile-context]: #compilecontext
[api-compile-data]: #compiledata
[api-encoding]: #encoding
[api-extension]: #extension
[api-handle]: #handle
[api-on-enter-error]: #onentererror
[api-on-exit-error]: #onexiterror
[api-options]: #options
[api-token]: #token
[api-transform]: #transform
[api-value]: #value