remark-embed-images
Advanced tools
Comparing version 1.0.1 to 1.0.2
{ | ||
"name": "remark-embed-images", | ||
"version": "1.0.1", | ||
"description": "Embed images with data: URIs, inlining base64-encoded sources", | ||
"version": "1.0.2", | ||
"description": "remark plugin to embed images with data URIs, inlining base64-encoded sources", | ||
"license": "MIT", | ||
"keywords": [ | ||
"unified", | ||
"remark", | ||
"plugin", | ||
"mdast", | ||
"markdown", | ||
"image", | ||
"embed", | ||
"base64", | ||
"inline", | ||
"remark" | ||
"inline" | ||
], | ||
"repository": "https://github.com/remarkjs/remark-embed-images", | ||
"repository": "remarkjs/remark-embed-images", | ||
"bugs": "https://github.com/remarkjs/remark-embed-images/issues", | ||
@@ -28,22 +32,22 @@ "author": "David Herges <david@spektrakel.de> (https://spektrakel.de)", | ||
"devDependencies": { | ||
"@commitlint/cli": "^7.2.1", | ||
"@commitlint/config-conventional": "^7.1.2", | ||
"husky": "^1.1.0", | ||
"nyc": "^13.0.0", | ||
"prettier": "^1.14.2", | ||
"browserify": "^16.0.0", | ||
"nyc": "^14.0.0", | ||
"prettier": "^1.0.0", | ||
"remark": "^10.0.0", | ||
"remark-cli": "^6.0.0", | ||
"remark-html": "^9.0.0", | ||
"remark-preset-wooorm": "^4.0.0", | ||
"standard-version": "^4.2.0", | ||
"remark-preset-wooorm": "^5.0.0", | ||
"tape": "^4.0.0", | ||
"to-vfile": "^5.0.0", | ||
"xo": "^0.23.0" | ||
"tinyify": "^2.0.0", | ||
"to-vfile": "^6.0.0", | ||
"xo": "^0.24.0" | ||
}, | ||
"scripts": { | ||
"format": "remark readme.md -qfo && prettier --write \"**/*.js\" && xo --fix", | ||
"test:api": "node test", | ||
"test:coverage": "nyc --reporter lcov tape test/index.js", | ||
"test": "yarn run format && yarn run test:coverage", | ||
"release": "standard-version --prerelease pre --message 'release: cut v%s'" | ||
"format": "remark *.md -qfo && prettier --write \"**/*.js\" && xo --fix", | ||
"build-bundle": "browserify . -s remarkEmbedImages -o remark-embed-images.js", | ||
"build-mangle": "browserify . -s remarkEmbedImages -p tinyify -o remark-embed-images.min.js", | ||
"build": "npm run build-bundle && npm run build-mangle", | ||
"test-api": "node test", | ||
"test-coverage": "nyc --reporter lcov tape test/index.js", | ||
"test": "npm run format && npm run build && npm run test-coverage" | ||
}, | ||
@@ -56,7 +60,2 @@ "nyc": { | ||
}, | ||
"remarkConfig": { | ||
"plugins": [ | ||
"preset-wooorm" | ||
] | ||
}, | ||
"prettier": { | ||
@@ -74,12 +73,7 @@ "tabWidth": 2, | ||
}, | ||
"commitlint": { | ||
"extends": [ | ||
"@commitlint/config-conventional" | ||
"remarkConfig": { | ||
"plugins": [ | ||
"preset-wooorm" | ||
] | ||
}, | ||
"husky": { | ||
"hooks": { | ||
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS" | ||
} | ||
} | ||
} |
# remark-embed-images | ||
[![Travis][travis-badge]][travis] | ||
[![Circle][circle-badge]][circle] | ||
[![Build][build-badge]][build] | ||
[![Coverage][coverage-badge]][coverage] | ||
[![Downloads][downloads-badge]][downloads] | ||
[![Chat][chat-badge]][chat] | ||
[![Size][size-badge]][size] | ||
[![Sponsors][sponsors-badge]][collective] | ||
[![Backers][backers-badge]][collective] | ||
[![Chat][chat-badge]][chat] | ||
Embed local images as data URIs, inlining files as base64-encoded values. | ||
[**remark**][remark] plugin to embed local images as data URIs, inlining files | ||
as base64-encoded values. | ||
## Installation | ||
## Install | ||
[npm][]: | ||
```bash | ||
```sh | ||
npm install remark-embed-images | ||
``` | ||
## Usage | ||
## Use | ||
Say we have [foo.png][], and next to it the following file, `example.md`: | ||
Say we have an image, [`foo.png`][foo.png], and next to it the following file, | ||
`example.md`: | ||
@@ -31,3 +33,3 @@ ```markdown | ||
```javascript | ||
```js | ||
var vfile = require('to-vfile') | ||
@@ -53,13 +55,15 @@ var remark = require('remark') | ||
### `remark.use(embedImages)` | ||
### `remark().use(embedImages)` | ||
Embed local images as data URIs. | ||
Embed local images as data URIs, inlining files as base64-encoded values. | ||
## Contribute | ||
See [`contributing.md` in `remarkjs/remark`][contributing] for ways to get | ||
started. | ||
See [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways | ||
to get started. | ||
See [`support.md`][support] for ways to get help. | ||
This organisation has a [Code of Conduct][coc]. By interacting with this | ||
repository, organisation, or community you agree to abide by its terms. | ||
This project has a [Code of Conduct][coc]. | ||
By interacting with this repository, organisation, or community you agree to | ||
abide by its terms. | ||
@@ -72,10 +76,6 @@ ## License | ||
[travis-badge]: https://img.shields.io/travis/remarkjs/remark-embed-images.svg | ||
[build-badge]: https://img.shields.io/travis/remarkjs/remark-embed-images/master.svg | ||
[travis]: https://travis-ci.org/remarkjs/remark-embed-images | ||
[build]: https://travis-ci.org/remarkjs/remark-embed-images | ||
[circle-badge]: https://img.shields.io/circleci/project/github/remarkjs/remark-embed-images/master.svg | ||
[circle]: https://circleci.com/gh/remarkjs/remark-embed-images | ||
[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-embed-images.svg | ||
@@ -89,5 +89,5 @@ | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
[size-badge]: https://img.shields.io/bundlephobia/minzip/remark-embed-images.svg | ||
[chat]: https://spectrum.chat/unified/remark | ||
[size]: https://bundlephobia.com/result?p=remark-embed-images | ||
@@ -100,12 +100,22 @@ [sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg | ||
[license]: license | ||
[chat-badge]: https://img.shields.io/badge/join%20the%20community-on%20spectrum-7b16ff.svg | ||
[author]: https://spektrakel.de | ||
[chat]: https://spectrum.chat/unified/remark | ||
[npm]: https://docs.npmjs.com/cli/install | ||
[contributing]: https://github.com/remarkjs/remark/blob/master/contributing.md | ||
[health]: https://github.com/remarkjs/.github | ||
[coc]: https://github.com/remarkjs/remark/blob/master/code-of-conduct.md | ||
[contributing]: https://github.com/remarkjs/.github/blob/master/contributing.md | ||
[support]: https://github.com/remarkjs/.github/blob/master/support.md | ||
[coc]: https://github.com/remarkjs/.github/blob/master/code-of-conduct.md | ||
[license]: license | ||
[author]: https://spektrakel.de | ||
[remark]: https://github.com/remarkjs/remark | ||
[foo.png]: test/fixtures/foo.png |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No repository
Supply chain riskPackage does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.
Found 1 instance in 1 package
11
117
6799
4