This commit is contained in:
11
node_modules/mdast-util-gfm-strikethrough/from-markdown.js
generated
vendored
Normal file
11
node_modules/mdast-util-gfm-strikethrough/from-markdown.js
generated
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
exports.canContainEols = ['delete']
|
||||
exports.enter = {strikethrough: enterStrikethrough}
|
||||
exports.exit = {strikethrough: exitStrikethrough}
|
||||
|
||||
function enterStrikethrough(token) {
|
||||
this.enter({type: 'delete', children: []}, token)
|
||||
}
|
||||
|
||||
function exitStrikethrough(token) {
|
||||
this.exit(token)
|
||||
}
|
||||
2
node_modules/mdast-util-gfm-strikethrough/index.js
generated
vendored
Normal file
2
node_modules/mdast-util-gfm-strikethrough/index.js
generated
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
exports.fromMarkdown = require('./from-markdown')
|
||||
exports.toMarkdown = require('./to-markdown')
|
||||
22
node_modules/mdast-util-gfm-strikethrough/license
generated
vendored
Normal file
22
node_modules/mdast-util-gfm-strikethrough/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.
|
||||
80
node_modules/mdast-util-gfm-strikethrough/package.json
generated
vendored
Normal file
80
node_modules/mdast-util-gfm-strikethrough/package.json
generated
vendored
Normal file
@@ -0,0 +1,80 @@
|
||||
{
|
||||
"name": "mdast-util-gfm-strikethrough",
|
||||
"version": "0.2.3",
|
||||
"description": "mdast extension to parse and serialize GFM strikethrough",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"unist",
|
||||
"mdast",
|
||||
"mdast-util",
|
||||
"util",
|
||||
"utility",
|
||||
"markdown",
|
||||
"markup",
|
||||
"strikethrough",
|
||||
"strike",
|
||||
"through",
|
||||
"del",
|
||||
"delete",
|
||||
"deletion",
|
||||
"gfm"
|
||||
],
|
||||
"repository": "syntax-tree/mdast-util-gfm-strikethrough",
|
||||
"bugs": "https://github.com/syntax-tree/mdast-util-gfm-strikethrough/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)"
|
||||
],
|
||||
"files": [
|
||||
"from-markdown.js",
|
||||
"index.js",
|
||||
"to-markdown.js"
|
||||
],
|
||||
"dependencies": {
|
||||
"mdast-util-to-markdown": "^0.6.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"mdast-util-from-markdown": "^0.8.0",
|
||||
"micromark-extension-gfm-strikethrough": "^0.6.0",
|
||||
"nyc": "^15.0.0",
|
||||
"prettier": "^2.0.0",
|
||||
"remark-cli": "^9.0.0",
|
||||
"remark-preset-wooorm": "^8.0.0",
|
||||
"tape": "^5.0.0",
|
||||
"unist-util-remove-position": "^3.0.0",
|
||||
"xo": "^0.36.0"
|
||||
},
|
||||
"scripts": {
|
||||
"format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
|
||||
"test-api": "node test",
|
||||
"test-coverage": "nyc --reporter lcov tape test.js",
|
||||
"test": "npm run format && npm run test-coverage"
|
||||
},
|
||||
"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
|
||||
},
|
||||
"remarkConfig": {
|
||||
"plugins": [
|
||||
"preset-wooorm"
|
||||
]
|
||||
}
|
||||
}
|
||||
173
node_modules/mdast-util-gfm-strikethrough/readme.md
generated
vendored
Normal file
173
node_modules/mdast-util-gfm-strikethrough/readme.md
generated
vendored
Normal file
@@ -0,0 +1,173 @@
|
||||
# mdast-util-gfm-strikethrough
|
||||
|
||||
[![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]
|
||||
|
||||
Extension for [`mdast-util-from-markdown`][from-markdown] and/or
|
||||
[`mdast-util-to-markdown`][to-markdown] to support GitHub flavored markdown
|
||||
strikethrough (~~like this~~) in **[mdast][]**.
|
||||
When parsing (`from-markdown`), must be combined with
|
||||
[`micromark-extension-gfm-strikethrough`][extension].
|
||||
|
||||
You probably shouldn’t use this package directly, but instead use
|
||||
[`remark-gfm`][remark-gfm] with **[remark][]**.
|
||||
|
||||
## Install
|
||||
|
||||
[npm][]:
|
||||
|
||||
```sh
|
||||
npm install mdast-util-gfm-strikethrough
|
||||
```
|
||||
|
||||
## Use
|
||||
|
||||
Say our script, `example.js`, looks as follows:
|
||||
|
||||
```js
|
||||
var fromMarkdown = require('mdast-util-from-markdown')
|
||||
var toMarkdown = require('mdast-util-to-markdown')
|
||||
var syntax = require('micromark-extension-gfm-strikethrough')
|
||||
var strikethrough = require('mdast-util-gfm-strikethrough')
|
||||
|
||||
var doc = '*Emphasis*, **importance**, and ~~strikethrough~~.'
|
||||
|
||||
var tree = fromMarkdown(doc, {
|
||||
extensions: [syntax()],
|
||||
mdastExtensions: [strikethrough.fromMarkdown]
|
||||
})
|
||||
|
||||
console.log(tree)
|
||||
|
||||
var out = toMarkdown(tree, {extensions: [strikethrough.toMarkdown]})
|
||||
|
||||
console.log(out)
|
||||
```
|
||||
|
||||
Now, running `node example` yields:
|
||||
|
||||
```js
|
||||
{
|
||||
type: 'root',
|
||||
children: [
|
||||
{
|
||||
type: 'paragraph',
|
||||
children: [
|
||||
{type: 'emphasis', children: [{type: 'text', value: 'Emphasis'}]},
|
||||
{type: 'text', value: ', '},
|
||||
{type: 'strong', children: [{type: 'text', value: 'importance'}]},
|
||||
{type: 'text', value: ', and '},
|
||||
{type: 'delete', children: [{type: 'text', value: 'strikethrough'}]},
|
||||
{type: 'text', value: '.'}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
```markdown
|
||||
*Emphasis*, **importance**, and ~~strikethrough~~.
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### `strikethrough.fromMarkdown`
|
||||
|
||||
### `strikethrough.toMarkdown`
|
||||
|
||||
> Note: the separate extensions are also available at
|
||||
> `mdast-util-gfm-strikethrough/from-markdown` and
|
||||
> `mdast-util-gfm-strikethrough/to-markdown`.
|
||||
|
||||
Support strikethrough.
|
||||
The exports are extensions, respectively
|
||||
for [`mdast-util-from-markdown`][from-markdown] and
|
||||
[`mdast-util-to-markdown`][to-markdown].
|
||||
|
||||
## Related
|
||||
|
||||
* [`remarkjs/remark`][remark]
|
||||
— markdown processor powered by plugins
|
||||
* [`remarkjs/remark-gfm`][remark-gfm]
|
||||
— remark plugin to support GFM
|
||||
* [`micromark/micromark`][micromark]
|
||||
— the smallest commonmark-compliant markdown parser that exists
|
||||
* [`micromark/micromark-extension-gfm-strikethrough`][extension]
|
||||
— micromark extension to parse GFM strikethrough
|
||||
* [`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
|
||||
|
||||
## Contribute
|
||||
|
||||
See [`contributing.md` in `syntax-tree/.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/syntax-tree/mdast-util-gfm-strikethrough/workflows/main/badge.svg
|
||||
|
||||
[build]: https://github.com/syntax-tree/mdast-util-gfm-strikethrough/actions
|
||||
|
||||
[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/mdast-util-gfm-strikethrough.svg
|
||||
|
||||
[coverage]: https://codecov.io/github/syntax-tree/mdast-util-gfm-strikethrough
|
||||
|
||||
[downloads-badge]: https://img.shields.io/npm/dm/mdast-util-gfm-strikethrough.svg
|
||||
|
||||
[downloads]: https://www.npmjs.com/package/mdast-util-gfm-strikethrough
|
||||
|
||||
[size-badge]: https://img.shields.io/bundlephobia/minzip/mdast-util-gfm-strikethrough.svg
|
||||
|
||||
[size]: https://bundlephobia.com/result?p=mdast-util-gfm-strikethrough
|
||||
|
||||
[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
|
||||
|
||||
[license]: license
|
||||
|
||||
[author]: https://wooorm.com
|
||||
|
||||
[contributing]: https://github.com/syntax-tree/.github/blob/HEAD/contributing.md
|
||||
|
||||
[support]: https://github.com/syntax-tree/.github/blob/HEAD/support.md
|
||||
|
||||
[coc]: https://github.com/syntax-tree/.github/blob/HEAD/code-of-conduct.md
|
||||
|
||||
[mdast]: https://github.com/syntax-tree/mdast
|
||||
|
||||
[remark]: https://github.com/remarkjs/remark
|
||||
|
||||
[remark-gfm]: https://github.com/remarkjs/remark-gfm
|
||||
|
||||
[from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
|
||||
|
||||
[to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown
|
||||
|
||||
[micromark]: https://github.com/micromark/micromark
|
||||
|
||||
[extension]: https://github.com/micromark/micromark-extension-gfm-strikethrough
|
||||
17
node_modules/mdast-util-gfm-strikethrough/to-markdown.js
generated
vendored
Normal file
17
node_modules/mdast-util-gfm-strikethrough/to-markdown.js
generated
vendored
Normal file
@@ -0,0 +1,17 @@
|
||||
var phrasing = require('mdast-util-to-markdown/lib/util/container-phrasing')
|
||||
|
||||
exports.unsafe = [{character: '~', inConstruct: 'phrasing'}]
|
||||
exports.handlers = {delete: handleDelete}
|
||||
|
||||
handleDelete.peek = peekDelete
|
||||
|
||||
function handleDelete(node, _, context) {
|
||||
var exit = context.enter('emphasis')
|
||||
var value = phrasing(node, context, {before: '~', after: '~'})
|
||||
exit()
|
||||
return '~~' + value + '~~'
|
||||
}
|
||||
|
||||
function peekDelete() {
|
||||
return '~'
|
||||
}
|
||||
Reference in New Issue
Block a user