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
12
node_modules/mdast-util-gfm/index.d.ts
generated
vendored
Normal file
12
node_modules/mdast-util-gfm/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,12 @@
|
||||
import type {ToMarkdownOptions as FootnoteOptions} from 'mdast-util-gfm-footnote'
|
||||
import type {Options as TableOptions} from 'mdast-util-gfm-table'
|
||||
|
||||
/**
|
||||
* Configuration for `gfmToMarkdown` from `mdast-util-gfm`.
|
||||
*
|
||||
* Currently supports options for `mdast-util-gfm-footnote` and
|
||||
* `mdast-util-gfm-table`.
|
||||
*/
|
||||
export interface Options extends FootnoteOptions, TableOptions {}
|
||||
|
||||
export {gfmFromMarkdown, gfmToMarkdown} from './lib/index.js'
|
||||
2
node_modules/mdast-util-gfm/index.js
generated
vendored
Normal file
2
node_modules/mdast-util-gfm/index.js
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
// Note: types exposed from `index.d.ts`.
|
||||
export {gfmFromMarkdown, gfmToMarkdown} from './lib/index.js'
|
||||
24
node_modules/mdast-util-gfm/lib/index.d.ts
generated
vendored
Normal file
24
node_modules/mdast-util-gfm/lib/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
/**
|
||||
* Create an extension for `mdast-util-from-markdown` to enable GFM (autolink
|
||||
* literals, footnotes, strikethrough, tables, tasklists).
|
||||
*
|
||||
* @returns {Array<FromMarkdownExtension>}
|
||||
* Extension for `mdast-util-from-markdown` to enable GFM (autolink literals,
|
||||
* footnotes, strikethrough, tables, tasklists).
|
||||
*/
|
||||
export function gfmFromMarkdown(): Array<FromMarkdownExtension>;
|
||||
/**
|
||||
* Create an extension for `mdast-util-to-markdown` to enable GFM (autolink
|
||||
* literals, footnotes, strikethrough, tables, tasklists).
|
||||
*
|
||||
* @param {Options | null | undefined} [options]
|
||||
* Configuration (optional).
|
||||
* @returns {ToMarkdownExtension}
|
||||
* Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
|
||||
* footnotes, strikethrough, tables, tasklists).
|
||||
*/
|
||||
export function gfmToMarkdown(options?: Options | null | undefined): ToMarkdownExtension;
|
||||
import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown';
|
||||
import type { Options } from 'mdast-util-gfm';
|
||||
import type { Options as ToMarkdownExtension } from 'mdast-util-to-markdown';
|
||||
//# sourceMappingURL=index.d.ts.map
|
||||
1
node_modules/mdast-util-gfm/lib/index.d.ts.map
generated
vendored
Normal file
1
node_modules/mdast-util-gfm/lib/index.d.ts.map
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["index.js"],"names":[],"mappings":"AAwBA;;;;;;;GAOG;AACH,mCAJa,KAAK,CAAC,qBAAqB,CAAC,CAYxC;AAED;;;;;;;;;GASG;AACH,wCANW,OAAO,GAAG,IAAI,GAAG,SAAS,GAExB,mBAAmB,CAc/B;wDA7DoD,0BAA0B;6BACrD,gBAAgB;oDACO,wBAAwB"}
|
||||
63
node_modules/mdast-util-gfm/lib/index.js
generated
vendored
Normal file
63
node_modules/mdast-util-gfm/lib/index.js
generated
vendored
Normal file
@@ -0,0 +1,63 @@
|
||||
/**
|
||||
* @import {Extension as FromMarkdownExtension} from 'mdast-util-from-markdown'
|
||||
* @import {Options} from 'mdast-util-gfm'
|
||||
* @import {Options as ToMarkdownExtension} from 'mdast-util-to-markdown'
|
||||
*/
|
||||
|
||||
import {
|
||||
gfmAutolinkLiteralFromMarkdown,
|
||||
gfmAutolinkLiteralToMarkdown
|
||||
} from 'mdast-util-gfm-autolink-literal'
|
||||
import {
|
||||
gfmFootnoteFromMarkdown,
|
||||
gfmFootnoteToMarkdown
|
||||
} from 'mdast-util-gfm-footnote'
|
||||
import {
|
||||
gfmStrikethroughFromMarkdown,
|
||||
gfmStrikethroughToMarkdown
|
||||
} from 'mdast-util-gfm-strikethrough'
|
||||
import {gfmTableFromMarkdown, gfmTableToMarkdown} from 'mdast-util-gfm-table'
|
||||
import {
|
||||
gfmTaskListItemFromMarkdown,
|
||||
gfmTaskListItemToMarkdown
|
||||
} from 'mdast-util-gfm-task-list-item'
|
||||
|
||||
/**
|
||||
* Create an extension for `mdast-util-from-markdown` to enable GFM (autolink
|
||||
* literals, footnotes, strikethrough, tables, tasklists).
|
||||
*
|
||||
* @returns {Array<FromMarkdownExtension>}
|
||||
* Extension for `mdast-util-from-markdown` to enable GFM (autolink literals,
|
||||
* footnotes, strikethrough, tables, tasklists).
|
||||
*/
|
||||
export function gfmFromMarkdown() {
|
||||
return [
|
||||
gfmAutolinkLiteralFromMarkdown(),
|
||||
gfmFootnoteFromMarkdown(),
|
||||
gfmStrikethroughFromMarkdown(),
|
||||
gfmTableFromMarkdown(),
|
||||
gfmTaskListItemFromMarkdown()
|
||||
]
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an extension for `mdast-util-to-markdown` to enable GFM (autolink
|
||||
* literals, footnotes, strikethrough, tables, tasklists).
|
||||
*
|
||||
* @param {Options | null | undefined} [options]
|
||||
* Configuration (optional).
|
||||
* @returns {ToMarkdownExtension}
|
||||
* Extension for `mdast-util-to-markdown` to enable GFM (autolink literals,
|
||||
* footnotes, strikethrough, tables, tasklists).
|
||||
*/
|
||||
export function gfmToMarkdown(options) {
|
||||
return {
|
||||
extensions: [
|
||||
gfmAutolinkLiteralToMarkdown(),
|
||||
gfmFootnoteToMarkdown(options),
|
||||
gfmStrikethroughToMarkdown(),
|
||||
gfmTableToMarkdown(options),
|
||||
gfmTaskListItemToMarkdown()
|
||||
]
|
||||
}
|
||||
}
|
||||
22
node_modules/mdast-util-gfm/license
generated
vendored
Normal file
22
node_modules/mdast-util-gfm/license
generated
vendored
Normal 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.
|
||||
125
node_modules/mdast-util-gfm/package.json
generated
vendored
Normal file
125
node_modules/mdast-util-gfm/package.json
generated
vendored
Normal file
@@ -0,0 +1,125 @@
|
||||
{
|
||||
"author": "Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)",
|
||||
"bugs": "https://github.com/syntax-tree/mdast-util-gfm/issues",
|
||||
"contributors": [
|
||||
"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)"
|
||||
],
|
||||
"dependencies": {
|
||||
"mdast-util-from-markdown": "^2.0.0",
|
||||
"mdast-util-gfm-autolink-literal": "^2.0.0",
|
||||
"mdast-util-gfm-footnote": "^2.0.0",
|
||||
"mdast-util-gfm-strikethrough": "^2.0.0",
|
||||
"mdast-util-gfm-table": "^2.0.0",
|
||||
"mdast-util-gfm-task-list-item": "^2.0.0",
|
||||
"mdast-util-to-markdown": "^2.0.0"
|
||||
},
|
||||
"description": "mdast extension to parse and serialize GFM (GitHub Flavored Markdown)",
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.0.0",
|
||||
"c8": "^10.0.0",
|
||||
"github-slugger": "^2.0.0",
|
||||
"hast-util-to-html": "^9.0.0",
|
||||
"mdast-util-to-hast": "^13.0.0",
|
||||
"micromark-extension-gfm": "^3.0.0",
|
||||
"prettier": "^3.0.0",
|
||||
"remark-cli": "^12.0.0",
|
||||
"remark-preset-wooorm": "^11.0.0",
|
||||
"type-coverage": "^2.0.0",
|
||||
"typescript": "^5.0.0",
|
||||
"undici": "^7.0.0",
|
||||
"xo": "^0.60.0"
|
||||
},
|
||||
"exports": "./index.js",
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"index.js",
|
||||
"lib/"
|
||||
],
|
||||
"funding": {
|
||||
"type": "opencollective",
|
||||
"url": "https://opencollective.com/unified"
|
||||
},
|
||||
"keywords": [
|
||||
"autolink",
|
||||
"gfm",
|
||||
"github",
|
||||
"markdown",
|
||||
"markup",
|
||||
"mdast-util",
|
||||
"mdast",
|
||||
"strikethrough",
|
||||
"table",
|
||||
"tagfilter",
|
||||
"tasklist",
|
||||
"unist",
|
||||
"utility",
|
||||
"util"
|
||||
],
|
||||
"license": "MIT",
|
||||
"name": "mdast-util-gfm",
|
||||
"prettier": {
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"singleQuote": true,
|
||||
"tabWidth": 2,
|
||||
"trailingComma": "none",
|
||||
"useTabs": false
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"remark-preset-wooorm"
|
||||
]
|
||||
},
|
||||
"repository": "syntax-tree/mdast-util-gfm",
|
||||
"scripts": {
|
||||
"build": "tsc --build --clean && tsc --build && type-coverage",
|
||||
"crawl": "node --conditions development script/crawl-tests.js",
|
||||
"format": "remark --frail --output --quiet -- . && prettier --log-level warn --write -- . && xo --fix",
|
||||
"test-api-prod": "node --conditions production test/index.js",
|
||||
"test-api-dev": "node --conditions development 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": "3.1.0",
|
||||
"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
|
||||
}
|
||||
}
|
||||
497
node_modules/mdast-util-gfm/readme.md
generated
vendored
Normal file
497
node_modules/mdast-util-gfm/readme.md
generated
vendored
Normal file
@@ -0,0 +1,497 @@
|
||||
# mdast-util-gfm
|
||||
|
||||
[![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][] extensions to parse and serialize [GFM][] (autolink literals,
|
||||
footnotes, strikethrough, tables, tasklists).
|
||||
|
||||
## Contents
|
||||
|
||||
* [What is this?](#what-is-this)
|
||||
* [When to use this](#when-to-use-this)
|
||||
* [Install](#install)
|
||||
* [Use](#use)
|
||||
* [API](#api)
|
||||
* [`gfmFromMarkdown()`](#gfmfrommarkdown)
|
||||
* [`gfmToMarkdown(options?)`](#gfmtomarkdownoptions)
|
||||
* [`Options`](#options)
|
||||
* [HTML](#html)
|
||||
* [Syntax](#syntax)
|
||||
* [Syntax tree](#syntax-tree)
|
||||
* [Types](#types)
|
||||
* [Compatibility](#compatibility)
|
||||
* [Related](#related)
|
||||
* [Contribute](#contribute)
|
||||
* [License](#license)
|
||||
|
||||
## What is this?
|
||||
|
||||
This package contains two extensions that add support for GFM syntax in
|
||||
markdown to [mdast][]: autolink literals (`www.x.com`), footnotes (`[^1]`),
|
||||
strikethrough (`~~stuff~~`), tables (`| cell |…`), and tasklists (`* [x]`).
|
||||
These extensions plug into
|
||||
[`mdast-util-from-markdown`][mdast-util-from-markdown] (to support parsing
|
||||
GFM in markdown into a syntax tree) and
|
||||
[`mdast-util-to-markdown`][mdast-util-to-markdown] (to support serializing
|
||||
GFM in syntax trees to markdown).
|
||||
|
||||
## When to use this
|
||||
|
||||
This project is useful when you want to support the same features that GitHub
|
||||
does in files in a repo, Gists, and several other places.
|
||||
Users frequently believe that some of these extensions, specifically autolink
|
||||
literals and tables, are part of normal markdown, so using `mdast-util-gfm` will
|
||||
help match your implementation to their understanding of markdown.
|
||||
There are several edge cases where GitHub’s implementation works in unexpected
|
||||
ways or even different than described in their spec, so *writing* in GFM is not
|
||||
always the best choice.
|
||||
|
||||
You can use these extensions when you are working with
|
||||
`mdast-util-from-markdown` and `mdast-util-to-markdown` already.
|
||||
|
||||
When working with `mdast-util-from-markdown`, you must combine this package
|
||||
with [`micromark-extension-gfm`][extension].
|
||||
|
||||
Instead of this package, you can also use the extensions separately:
|
||||
|
||||
* [`mdast-util-gfm-autolink-literal`](https://github.com/syntax-tree/mdast-util-gfm-autolink-literal)
|
||||
— support GFM autolink literals
|
||||
* [`mdast-util-gfm-footnote`](https://github.com/syntax-tree/mdast-util-gfm-footnote)
|
||||
— support GFM footnotes
|
||||
* [`mdast-util-gfm-strikethrough`](https://github.com/syntax-tree/mdast-util-gfm-strikethrough)
|
||||
— support GFM strikethrough
|
||||
* [`mdast-util-gfm-table`](https://github.com/syntax-tree/mdast-util-gfm-table)
|
||||
— support GFM tables
|
||||
* [`mdast-util-gfm-task-list-item`](https://github.com/syntax-tree/mdast-util-gfm-task-list-item)
|
||||
— support GFM tasklists
|
||||
|
||||
A different utility, [`mdast-util-frontmatter`][mdast-util-frontmatter], adds
|
||||
support for frontmatter.
|
||||
GitHub supports YAML frontmatter for files in repos and Gists but they don’t
|
||||
treat it as part of GFM.
|
||||
|
||||
All these packages are used in [`remark-gfm`][remark-gfm], which
|
||||
focusses on making it easier to transform content by abstracting these
|
||||
internals away.
|
||||
|
||||
This utility does not handle how markdown is turned to HTML.
|
||||
That’s done by [`mdast-util-to-hast`][mdast-util-to-hast].
|
||||
If your content is not in English, you should configure that utility.
|
||||
|
||||
## Install
|
||||
|
||||
This package is [ESM only][esm].
|
||||
In Node.js (version 16+), install with [npm][]:
|
||||
|
||||
```sh
|
||||
npm install mdast-util-gfm
|
||||
```
|
||||
|
||||
In Deno with [`esm.sh`][esmsh]:
|
||||
|
||||
```js
|
||||
import {gfmFromMarkdown, gfmToMarkdown} from 'https://esm.sh/mdast-util-gfm@3'
|
||||
```
|
||||
|
||||
In browsers with [`esm.sh`][esmsh]:
|
||||
|
||||
```html
|
||||
<script type="module">
|
||||
import {gfmFromMarkdown, gfmToMarkdown} from 'https://esm.sh/mdast-util-gfm@3?bundle'
|
||||
</script>
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Say our document `example.md` contains:
|
||||
|
||||
```markdown
|
||||
# GFM
|
||||
|
||||
## Autolink literals
|
||||
|
||||
www.example.com, https://example.com, and contact@example.com.
|
||||
|
||||
## Footnote
|
||||
|
||||
A note[^1]
|
||||
|
||||
[^1]: Big note.
|
||||
|
||||
## Strikethrough
|
||||
|
||||
~one~ or ~~two~~ tildes.
|
||||
|
||||
## Table
|
||||
|
||||
| a | b | c | d |
|
||||
| - | :- | -: | :-: |
|
||||
|
||||
## Tasklist
|
||||
|
||||
* [ ] to do
|
||||
* [x] done
|
||||
```
|
||||
|
||||
…and our module `example.js` looks as follows:
|
||||
|
||||
```js
|
||||
import fs from 'node:fs/promises'
|
||||
import {fromMarkdown} from 'mdast-util-from-markdown'
|
||||
import {gfmFromMarkdown, gfmToMarkdown} from 'mdast-util-gfm'
|
||||
import {toMarkdown} from 'mdast-util-to-markdown'
|
||||
import {gfm} from 'micromark-extension-gfm'
|
||||
|
||||
const value = await fs.readFile('example.md', 'utf8')
|
||||
|
||||
const tree = fromMarkdown(value, {
|
||||
extensions: [gfm()],
|
||||
mdastExtensions: [gfmFromMarkdown()]
|
||||
})
|
||||
|
||||
console.log(tree)
|
||||
|
||||
const result = toMarkdown(tree, {extensions: [gfmToMarkdown()]})
|
||||
|
||||
console.log(result)
|
||||
```
|
||||
|
||||
…now running `node example.js` yields (positional info removed for brevity):
|
||||
|
||||
```js
|
||||
{
|
||||
type: 'root',
|
||||
children: [
|
||||
{type: 'heading', depth: 1, children: [{type: 'text', value: 'GFM'}]},
|
||||
{
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [{type: 'text', value: 'Autolink literals'}]
|
||||
},
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [
|
||||
{
|
||||
type: 'link',
|
||||
title: null,
|
||||
url: 'http://www.example.com',
|
||||
children: [{type: 'text', value: 'www.example.com'}]
|
||||
},
|
||||
{type: 'text', value: ', '},
|
||||
{
|
||||
type: 'link',
|
||||
title: null,
|
||||
url: 'https://example.com',
|
||||
children: [{type: 'text', value: 'https://example.com'}]
|
||||
},
|
||||
{type: 'text', value: ', and '},
|
||||
{
|
||||
type: 'link',
|
||||
title: null,
|
||||
url: 'mailto:contact@example.com',
|
||||
children: [{type: 'text', value: 'contact@example.com'}]
|
||||
},
|
||||
{type: 'text', value: '.'}
|
||||
]
|
||||
},
|
||||
{type: 'heading', depth: 2, children: [{type: 'text', value: 'Footnote'}]},
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [
|
||||
{type: 'text', value: 'A note'},
|
||||
{type: 'footnoteReference', identifier: '1', label: '1'}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'footnoteDefinition',
|
||||
identifier: '1',
|
||||
label: '1',
|
||||
children: [
|
||||
{type: 'paragraph', children: [{type: 'text', value: 'Big note.'}]}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'heading',
|
||||
depth: 2,
|
||||
children: [{type: 'text', value: 'Strikethrough'}]
|
||||
},
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [
|
||||
{
|
||||
type: 'delete',
|
||||
children: [{type: 'text', value: 'one'}]
|
||||
},
|
||||
{type: 'text', value: ' or '},
|
||||
{
|
||||
type: 'delete',
|
||||
children: [{type: 'text', value: 'two'}]
|
||||
},
|
||||
{type: 'text', value: ' tildes.'}
|
||||
]
|
||||
},
|
||||
{type: 'heading', depth: 2, children: [{type: 'text', value: 'Table'}]},
|
||||
{
|
||||
type: 'table',
|
||||
align: [null, 'left', 'right', 'center'],
|
||||
children: [
|
||||
{
|
||||
type: 'tableRow',
|
||||
children: [
|
||||
{type: 'tableCell', children: [{type: 'text', value: 'a'}]},
|
||||
{type: 'tableCell', children: [{type: 'text', value: 'b'}]},
|
||||
{type: 'tableCell', children: [{type: 'text', value: 'c'}]},
|
||||
{type: 'tableCell', children: [{type: 'text', value: 'd'}]}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{type: 'heading', depth: 2, children: [{type: 'text', value: 'Tasklist'}]},
|
||||
{
|
||||
type: 'list',
|
||||
ordered: false,
|
||||
start: null,
|
||||
spread: false,
|
||||
children: [
|
||||
{
|
||||
type: 'listItem',
|
||||
spread: false,
|
||||
checked: false,
|
||||
children: [
|
||||
{type: 'paragraph', children: [{type: 'text', value: 'to do'}]}
|
||||
]
|
||||
},
|
||||
{
|
||||
type: 'listItem',
|
||||
spread: false,
|
||||
checked: true,
|
||||
children: [
|
||||
{type: 'paragraph', children: [{type: 'text', value: 'done'}]}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```markdown
|
||||
# GFM
|
||||
|
||||
## Autolink literals
|
||||
|
||||
[www.example.com](http://www.example.com), <https://example.com>, and <contact@example.com>.
|
||||
|
||||
## Footnote
|
||||
|
||||
A note[^1]
|
||||
|
||||
[^1]: Big note.
|
||||
|
||||
## Strikethrough
|
||||
|
||||
~~one~~ or ~~two~~ tildes.
|
||||
|
||||
## Table
|
||||
|
||||
| a | b | c | d |
|
||||
| - | :- | -: | :-: |
|
||||
|
||||
## Tasklist
|
||||
|
||||
* [ ] to do
|
||||
* [x] done
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
This package exports the identifiers [`gfmFromMarkdown`][api-gfm-from-markdown]
|
||||
and [`gfmToMarkdown`][api-gfm-to-markdown].
|
||||
There is no default export.
|
||||
|
||||
### `gfmFromMarkdown()`
|
||||
|
||||
Create an extension for [`mdast-util-from-markdown`][mdast-util-from-markdown]
|
||||
to enable GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
|
||||
|
||||
###### Returns
|
||||
|
||||
Extension for `mdast-util-from-markdown` to enable GFM
|
||||
([`Array<FromMarkdownExtension>`][from-markdown-extension]).
|
||||
|
||||
### `gfmToMarkdown(options?)`
|
||||
|
||||
Create an extension for [`mdast-util-to-markdown`][mdast-util-to-markdown]
|
||||
to enable GFM (autolink literals, footnotes, strikethrough, tables, tasklists).
|
||||
|
||||
###### Parameters
|
||||
|
||||
* `options` ([`Options`][api-options])
|
||||
— configuration
|
||||
|
||||
###### Returns
|
||||
|
||||
Extension for `mdast-util-to-markdown` to enable GFM
|
||||
([`Array<ToMarkdownExtension>`][to-markdown-extension]).
|
||||
|
||||
### `Options`
|
||||
|
||||
Configuration (TypeScript type).
|
||||
|
||||
###### Fields
|
||||
|
||||
* `firstLineBlank` (`boolean`, default: `false`)
|
||||
— use a blank line for the first line of footnote definitions
|
||||
* `stringLength` (`((value: string) => number)`, default: `s => s.length`)
|
||||
— function to detect the length of table cell content, used when aligning
|
||||
the delimiters between cells
|
||||
* `tableCellPadding` (`boolean`, default: `true`)
|
||||
— whether to add a space of padding between delimiters and cells
|
||||
* `tablePipeAlign` (`boolean`, default: `true`)
|
||||
— whether to align the delimiters
|
||||
|
||||
## HTML
|
||||
|
||||
This utility does not handle how markdown is turned to HTML.
|
||||
That’s done by [`mdast-util-to-hast`][mdast-util-to-hast].
|
||||
|
||||
## Syntax
|
||||
|
||||
See [Syntax in `micromark-extension-gfm`][syntax].
|
||||
|
||||
## Syntax tree
|
||||
|
||||
This utility combines several mdast utilities.
|
||||
See their readmes for the node types supported in the tree:
|
||||
|
||||
* [`mdast-util-gfm-autolink-literal`](https://github.com/syntax-tree/mdast-util-gfm-autolink-literal#syntax-tree)
|
||||
— GFM autolink literals
|
||||
* [`mdast-util-gfm-footnote`](https://github.com/syntax-tree/mdast-util-gfm-footnote#syntax-tree)
|
||||
— GFM footnotes
|
||||
* [`mdast-util-gfm-strikethrough`](https://github.com/syntax-tree/mdast-util-gfm-strikethrough#syntax-tree)
|
||||
— GFM strikethrough
|
||||
* [`mdast-util-gfm-table`](https://github.com/syntax-tree/mdast-util-gfm-table#syntax-tree)
|
||||
— GFM tables
|
||||
* [`mdast-util-gfm-task-list-item`](https://github.com/syntax-tree/mdast-util-gfm-task-list-item#syntax-tree)
|
||||
— GFM tasklists
|
||||
|
||||
## Types
|
||||
|
||||
This package is fully typed with [TypeScript][].
|
||||
It exports the additional type [`Options`][api-options].
|
||||
|
||||
The `Delete`, `FootnoteDefinition`, `FootnoteReference`, `Table`, `TableRow`,
|
||||
and `TableCell` types of the mdast nodes are exposed from `@types/mdast`.
|
||||
|
||||
## 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-gfm@^3`,
|
||||
compatible with Node.js 16.
|
||||
|
||||
## Related
|
||||
|
||||
* [`remark-gfm`][remark-gfm]
|
||||
— remark plugin to support GFM
|
||||
* [`micromark-extension-gfm`][extension]
|
||||
— micromark extension to parse GFM
|
||||
|
||||
## 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 -->
|
||||
|
||||
[api-gfm-from-markdown]: #gfmfrommarkdown
|
||||
|
||||
[api-gfm-to-markdown]: #gfmtomarkdownoptions
|
||||
|
||||
[api-options]: #options
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
|
||||
|
||||
[build]: https://github.com/syntax-tree/mdast-util-gfm/actions
|
||||
|
||||
[build-badge]: https://github.com/syntax-tree/mdast-util-gfm/workflows/main/badge.svg
|
||||
|
||||
[chat]: https://github.com/syntax-tree/unist/discussions
|
||||
|
||||
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
|
||||
|
||||
[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md
|
||||
|
||||
[collective]: https://opencollective.com/unified
|
||||
|
||||
[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md
|
||||
|
||||
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/mdast-util-gfm
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm.svg
|
||||
|
||||
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
|
||||
|
||||
[esmsh]: https://esm.sh
|
||||
|
||||
[extension]: https://github.com/micromark/micromark-extension-gfm
|
||||
|
||||
[from-markdown-extension]: https://github.com/syntax-tree/mdast-util-from-markdown#extension
|
||||
|
||||
[gfm]: https://github.github.com/gfm/
|
||||
|
||||
[health]: https://github.com/syntax-tree/.github
|
||||
|
||||
[license]: license
|
||||
|
||||
[mdast]: https://github.com/syntax-tree/mdast
|
||||
|
||||
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
|
||||
|
||||
[mdast-util-frontmatter]: https://github.com/syntax-tree/mdast-util-frontmatter
|
||||
|
||||
[mdast-util-to-hast]: https://github.com/syntax-tree/mdast-util-to-hast
|
||||
|
||||
[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[remark-gfm]: https://github.com/remarkjs/remark-gfm
|
||||
|
||||
[size]: https://bundlejs.com/?q=mdast-util-gfm
|
||||
|
||||
[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=mdast-util-gfm
|
||||
|
||||
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
|
||||
|
||||
[support]: https://github.com/syntax-tree/.github/blob/main/support.md
|
||||
|
||||
[syntax]: https://github.com/micromark/micromark-extension-gfm#syntax
|
||||
|
||||
[to-markdown-extension]: https://github.com/syntax-tree/mdast-util-to-markdown#options
|
||||
|
||||
[typescript]: https://www.typescriptlang.org
|
||||
Reference in New Issue
Block a user