This commit is contained in:
8
node_modules/micromark-extension-gfm/html.js
generated
vendored
Normal file
8
node_modules/micromark-extension-gfm/html.js
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
var combine = require('micromark/dist/util/combine-html-extensions')
|
||||
var autolink = require('micromark-extension-gfm-autolink-literal/html')
|
||||
var strikethrough = require('micromark-extension-gfm-strikethrough/html')
|
||||
var table = require('micromark-extension-gfm-table/html')
|
||||
var tagfilter = require('micromark-extension-gfm-tagfilter/html')
|
||||
var tasklist = require('micromark-extension-gfm-task-list-item/html')
|
||||
|
||||
module.exports = combine([autolink, strikethrough, table, tagfilter, tasklist])
|
||||
1
node_modules/micromark-extension-gfm/index.js
generated
vendored
Normal file
1
node_modules/micromark-extension-gfm/index.js
generated
vendored
Normal file
@@ -0,0 +1 @@
|
||||
module.exports = require('./syntax')
|
||||
22
node_modules/micromark-extension-gfm/license
generated
vendored
Normal file
22
node_modules/micromark-extension-gfm/license
generated
vendored
Normal 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.
|
||||
95
node_modules/micromark-extension-gfm/package.json
generated
vendored
Normal file
95
node_modules/micromark-extension-gfm/package.json
generated
vendored
Normal file
@@ -0,0 +1,95 @@
|
||||
{
|
||||
"name": "micromark-extension-gfm",
|
||||
"version": "0.3.3",
|
||||
"description": "micromark extension to support GFM (GitHub Flavored Markdown)",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"micromark",
|
||||
"micromark-extension",
|
||||
"table",
|
||||
"strikethrough",
|
||||
"tasklist",
|
||||
"autolink",
|
||||
"tagfilter",
|
||||
"github",
|
||||
"gfm",
|
||||
"markdown",
|
||||
"unified"
|
||||
],
|
||||
"repository": "micromark/micromark-extension-gfm",
|
||||
"bugs": "https://github.com/micromark/micromark-extension-gfm/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)"
|
||||
],
|
||||
"types": "types/index.d.ts",
|
||||
"files": [
|
||||
"types/*.d.ts",
|
||||
"index.js",
|
||||
"html.js",
|
||||
"syntax.js"
|
||||
],
|
||||
"dependencies": {
|
||||
"micromark": "~2.11.0",
|
||||
"micromark-extension-gfm-autolink-literal": "~0.5.0",
|
||||
"micromark-extension-gfm-strikethrough": "~0.6.5",
|
||||
"micromark-extension-gfm-table": "~0.4.0",
|
||||
"micromark-extension-gfm-tagfilter": "~0.3.0",
|
||||
"micromark-extension-gfm-task-list-item": "~0.3.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"dtslint": "^4.0.0",
|
||||
"hast-util-select": "^4.0.0",
|
||||
"hast-util-to-text": "^2.0.0",
|
||||
"node-fetch": "^2.6.1",
|
||||
"nyc": "^15.0.0",
|
||||
"prettier": "^2.0.0",
|
||||
"rehype-parse": "^7.0.1",
|
||||
"remark-cli": "^9.0.0",
|
||||
"remark-preset-wooorm": "^8.0.0",
|
||||
"tape": "^5.0.0",
|
||||
"unified": "^9.0.0",
|
||||
"xo": "^0.38.0"
|
||||
},
|
||||
"scripts": {
|
||||
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
|
||||
"test-api": "node test",
|
||||
"test-coverage": "nyc --reporter lcov tape test/index.js",
|
||||
"test-types": "dtslint types",
|
||||
"test": "npm run format && npm run test-coverage && npm run test-types"
|
||||
},
|
||||
"nyc": {
|
||||
"check-coverage": true,
|
||||
"lines": 100,
|
||||
"functions": 100,
|
||||
"branches": 100
|
||||
},
|
||||
"prettier": {
|
||||
"tabWidth": 2,
|
||||
"useTabs": false,
|
||||
"singleQuote": true,
|
||||
"bracketSpacing": false,
|
||||
"semi": false,
|
||||
"trailingComma": "none"
|
||||
},
|
||||
"xo": {
|
||||
"prettier": true,
|
||||
"esnext": false,
|
||||
"ignores": [
|
||||
"types"
|
||||
],
|
||||
"rules": {
|
||||
"guard-for-in": "off",
|
||||
"unicorn/no-array-for-each": "off"
|
||||
}
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"preset-wooorm"
|
||||
]
|
||||
}
|
||||
}
|
||||
246
node_modules/micromark-extension-gfm/readme.md
generated
vendored
Normal file
246
node_modules/micromark-extension-gfm/readme.md
generated
vendored
Normal file
@@ -0,0 +1,246 @@
|
||||
# micromark-extension-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]
|
||||
|
||||
**[micromark][]** extension to support GitHub flavored markdown.
|
||||
This extension matches either the [GFM][] spec or github.com (default).
|
||||
|
||||
This package provides the low-level modules for integrating with the micromark
|
||||
tokenizer and the micromark HTML compiler.
|
||||
|
||||
You probably shouldn’t use this package directly, but instead use
|
||||
[`mdast-util-gfm`][mdast-util-gfm] with **[mdast][]** or `remark-gfm` with
|
||||
**[remark][]**.
|
||||
|
||||
Alternatively, the extensions can be used separately:
|
||||
|
||||
* [`micromark/micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal)
|
||||
— support GFM [autolink literals][]
|
||||
* [`micromark/micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough)
|
||||
— support GFM [strikethrough][]
|
||||
* [`micromark/micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table)
|
||||
— support GFM [tables][]
|
||||
* [`micromark/micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter)
|
||||
— support GFM [tagfilter][]
|
||||
* [`micromark/micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item)
|
||||
— support GFM [tasklists][]
|
||||
|
||||
## Install
|
||||
|
||||
[npm][]:
|
||||
|
||||
```sh
|
||||
npm install micromark-extension-gfm
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Say we have the following file, `example.md`:
|
||||
|
||||
```markdown
|
||||
# GFM
|
||||
|
||||
## Autolink literals
|
||||
|
||||
www.example.com, https://example.com, and contact@example.com.
|
||||
|
||||
## Strikethrough
|
||||
|
||||
~one~ or ~~two~~ tildes.
|
||||
|
||||
## Table
|
||||
|
||||
| a | b | c | d |
|
||||
| - | :- | -: | :-: |
|
||||
|
||||
## Tag filter
|
||||
|
||||
<plaintext>
|
||||
|
||||
## Tasklist
|
||||
|
||||
* [ ] to do
|
||||
* [x] done
|
||||
```
|
||||
|
||||
And our script, `example.js`, looks as follows:
|
||||
|
||||
```js
|
||||
var fs = require('fs')
|
||||
var micromark = require('micromark')
|
||||
var gfmSyntax = require('micromark-extension-gfm')
|
||||
var gfmHtml = require('micromark-extension-gfm/html')
|
||||
|
||||
var doc = fs.readFileSync('example.md')
|
||||
|
||||
var result = micromark(doc, {
|
||||
allowDangerousHtml: true,
|
||||
extensions: [gfmSyntax()],
|
||||
htmlExtensions: [gfmHtml]
|
||||
})
|
||||
|
||||
console.log(result)
|
||||
```
|
||||
|
||||
Now, running `node example` yields:
|
||||
|
||||
```html
|
||||
<h1>GFM</h1>
|
||||
<h2>Autolink literals</h2>
|
||||
<p><a href="http://www.example.com">www.example.com</a>, <a href="https://example.com">https://example.com</a>, and <a href="mailto:contact@example.com">contact@example.com</a>.</p>
|
||||
<h2>Strikethrough</h2>
|
||||
<p><del>one</del> or <del>two</del> tildes.</p>
|
||||
<h2>Table</h2>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>a</th>
|
||||
<th align="left">b</th>
|
||||
<th align="right">c</th>
|
||||
<th align="center">d</th>
|
||||
</tr>
|
||||
</thead>
|
||||
</table>
|
||||
<h2>Tag filter</h2>
|
||||
<plaintext>
|
||||
<h2>Tasklist</h2>
|
||||
<ul>
|
||||
<li><input disabled="" type="checkbox"> to do</li>
|
||||
<li><input checked="" disabled="" type="checkbox"> done</li>
|
||||
</ul>
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### `html`
|
||||
|
||||
### `syntax(options?)`
|
||||
|
||||
> Note: `syntax` is the default export of this module, `html` is available at
|
||||
> `micromark-extension-gfm/html`.
|
||||
|
||||
Support [GFM][] or markdown on github.com.
|
||||
|
||||
The export of `syntax` is a function that can be called with options and returns
|
||||
extension for the micromark parser (to tokenize GFM; can be passed in
|
||||
`extensions`).
|
||||
The export of html is an extension for the default HTML compiler (can be passed
|
||||
in `htmlExtensions`).
|
||||
|
||||
##### `options`
|
||||
|
||||
###### `options.singleTilde`
|
||||
|
||||
Passed as [`singleTilde`][single-tilde] in
|
||||
[`micromark-extension-gfm-strikethrough`][mm-strikethrough].
|
||||
|
||||
## Related
|
||||
|
||||
* [`remarkjs/remark`][remark]
|
||||
— markdown processor powered by plugins
|
||||
* [`syntax-tree/mdast-util-gfm`](https://github.com/syntax-tree/mdast-util-gfm)
|
||||
— mdast utility to support GFM
|
||||
* [`syntax-tree/mdast-util-from-markdown`][from-markdown]
|
||||
— mdast parser using `micromark` to create mdast from markdown
|
||||
* [`syntax-tree/mdast-util-to-markdown`][to-markdown]
|
||||
— mdast serializer to create markdown from mdast
|
||||
* [`micromark/micromark`][micromark]
|
||||
— the smallest commonmark-compliant markdown parser that exists
|
||||
* [`micromark/micromark-extension-gfm-autolink-literal`](https://github.com/micromark/micromark-extension-gfm-autolink-literal)
|
||||
— support GFM [autolink literals][]
|
||||
* [`micromark/micromark-extension-gfm-strikethrough`](https://github.com/micromark/micromark-extension-gfm-strikethrough)
|
||||
— support GFM [strikethrough][]
|
||||
* [`micromark/micromark-extension-gfm-table`](https://github.com/micromark/micromark-extension-gfm-table)
|
||||
— support GFM [tables][]
|
||||
* [`micromark/micromark-extension-gfm-tagfilter`](https://github.com/micromark/micromark-extension-gfm-tagfilter)
|
||||
— support GFM [tagfilter][]
|
||||
* [`micromark/micromark-extension-gfm-task-list-item`](https://github.com/micromark/micromark-extension-gfm-task-list-item)
|
||||
— support GFM [tasklists][]
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md` in `micromark/.github`][contributing] 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/micromark/micromark-extension-gfm/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/micromark/micromark-extension-gfm/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark-extension-gfm.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/micromark/micromark-extension-gfm
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-gfm.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/micromark-extension-gfm
|
||||
|
||||
[size-badge]: https://img.shields.io/bundlephobia/minzip/micromark-extension-gfm.svg
|
||||
|
||||
[size]: https://bundlephobia.com/result?p=micromark-extension-gfm
|
||||
|
||||
[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/micromark/micromark/discussions
|
||||
|
||||
[npm]: https://docs.npmjs.com/cli/install
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[contributing]: https://github.com/micromark/.github/blob/HEAD/contributing.md
|
||||
|
||||
[support]: https://github.com/micromark/.github/blob/HEAD/support.md
|
||||
|
||||
[coc]: https://github.com/micromark/.github/blob/HEAD/code-of-conduct.md
|
||||
|
||||
[micromark]: https://github.com/micromark/micromark
|
||||
|
||||
[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
|
||||
|
||||
[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
|
||||
|
||||
[remark]: https://github.com/remarkjs/remark
|
||||
|
||||
[mdast]: https://github.com/syntax-tree/mdast
|
||||
|
||||
[gfm]: https://github.github.com/gfm/
|
||||
|
||||
[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm
|
||||
|
||||
[strikethrough]: https://github.github.com/gfm/#strikethrough-extension-
|
||||
|
||||
[tables]: https://github.github.com/gfm/#tables-extension-
|
||||
|
||||
[tasklists]: https://github.github.com/gfm/#task-list-items-extension-
|
||||
|
||||
[autolink literals]: https://github.github.com/gfm/#autolinks-extension-
|
||||
|
||||
[tagfilter]: https://github.github.com/gfm/#disallowed-raw-html-extension-
|
||||
|
||||
[single-tilde]: https://github.com/micromark/micromark-extension-gfm-strikethrough#optionssingletilde
|
||||
|
||||
[mm-strikethrough]: https://github.com/micromark/micromark-extension-gfm-strikethrough
|
||||
11
node_modules/micromark-extension-gfm/syntax.js
generated
vendored
Normal file
11
node_modules/micromark-extension-gfm/syntax.js
generated
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
var combine = require('micromark/dist/util/combine-extensions')
|
||||
var autolink = require('micromark-extension-gfm-autolink-literal')
|
||||
var strikethrough = require('micromark-extension-gfm-strikethrough')
|
||||
var table = require('micromark-extension-gfm-table')
|
||||
var tasklist = require('micromark-extension-gfm-task-list-item')
|
||||
|
||||
module.exports = create
|
||||
|
||||
function create(options) {
|
||||
return combine([autolink, strikethrough(options), table, tasklist])
|
||||
}
|
||||
8
node_modules/micromark-extension-gfm/types/html.d.ts
generated
vendored
Normal file
8
node_modules/micromark-extension-gfm/types/html.d.ts
generated
vendored
Normal file
@@ -0,0 +1,8 @@
|
||||
import {HtmlExtension} from 'micromark/dist/shared-types'
|
||||
|
||||
/**
|
||||
* The export of html is an extension for the default HTML compiler (can be
|
||||
* passed in `htmlExtensions`).
|
||||
*/
|
||||
declare const html: HtmlExtension
|
||||
export = html
|
||||
19
node_modules/micromark-extension-gfm/types/index.d.ts
generated
vendored
Normal file
19
node_modules/micromark-extension-gfm/types/index.d.ts
generated
vendored
Normal file
@@ -0,0 +1,19 @@
|
||||
// TypeScript Version: 4.0
|
||||
|
||||
import {SyntaxExtension} from 'micromark/dist/shared-types'
|
||||
import {GfmStrikethroughOptions} from 'micromark-extension-gfm-strikethrough'
|
||||
|
||||
/**
|
||||
* Support GFM or markdown on github.com.
|
||||
*
|
||||
* The export of `syntax` is a function that can be called with options and
|
||||
* returns extension for the micromark parser (to tokenize GFM; can be passed
|
||||
* in `extensions`).
|
||||
*/
|
||||
declare function syntax(options?: syntax.GfmOptions): SyntaxExtension
|
||||
|
||||
declare namespace syntax {
|
||||
type GfmOptions = GfmStrikethroughOptions
|
||||
}
|
||||
|
||||
export = syntax
|
||||
Reference in New Issue
Block a user