https://github.com/metalsmith/snapshots
A metalsmith plugin that takes JSON snapshots of the Metalsmith files and metadata
https://github.com/metalsmith/snapshots
Last synced: 12 months ago
JSON representation
A metalsmith plugin that takes JSON snapshots of the Metalsmith files and metadata
- Host: GitHub
- URL: https://github.com/metalsmith/snapshots
- Owner: metalsmith
- License: mit
- Created: 2023-09-03T22:08:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-03T22:08:57.000Z (almost 3 years ago)
- Last Synced: 2025-03-06T16:47:05.045Z (over 1 year ago)
- Language: JavaScript
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
_Note: This is a template repository_
Usage:
1. Click "Use this template", see also https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template, fill in new plugin details
2. Search and replace all `core-plugin` `CorePlugin` and `corePlugin` matches with the name of the plugin
3. Change description in package.json & match in repo description
4. Remove this text
---
# @metalsmith/~core-plugin~
A metalsmith plugin to...
[![metalsmith: core plugin][metalsmith-badge]][metalsmith-url]
[![npm: version][npm-badge]][npm-url]
[![ci: build][ci-badge]][ci-url]
[![code coverage][codecov-badge]][codecov-url]
[![license: MIT][license-badge]][license-url]
## Features
An optional features section (if there are many), or an extended description of the core plugin
## Installation
NPM:
```
npm install @metalsmith/~core-plugin~
```
Yarn:
```
yarn add @metalsmith/~core-plugin~
```
## Usage
Pass `@metalsmith/~core-plugin~` to `metalsmith.use` :
```js
import ~corePlugin~ from '@metalsmith/~core-plugin~'
metalsmith.use(~corePlugin~()) // defaults
metalsmith.use(~corePlugin~({ // explicit defaults
...
}))
```
### Options
Optional section with list or table of options, if the plugin has a lot of options
### Specific usage example
Document a first specific usage example, the title can be "Achieve x by doing y"
### Specific usage example
Document a second specific usage example, the title can be "Achieve x by doing y"
### Debug
To enable debug logs, set the `DEBUG` environment variable to `@metalsmith/~core_plugin~*`:
```js
metalsmith.env('DEBUG', '@metalsmith/~core_plugin~*')
```
Alternatively you can set `DEBUG` to `@metalsmith/*` to debug all Metalsmith core plugins.
### CLI usage
To use this plugin with the Metalsmith CLI, add `@metalsmith/~core-plugin~` to the `plugins` key in your `metalsmith.json` file:
```json
{
"plugins": [
{
"@metalsmith/~core-plugin~": {}
}
]
}
```
## Credits (optional)
Special thanks to ... for ...
## License
[MIT](LICENSE)
[npm-badge]: https://img.shields.io/npm/v/@metalsmith/~core-plugin~.svg
[npm-url]: https://www.npmjs.com/package/@metalsmith/~core-plugin~
[ci-badge]: https://github.com/metalsmith/~core-plugin~/actions/workflows/test.yml/badge.svg
[ci-url]: https://github.com/metalsmith/~core-plugin~/actions/workflows/test.yml
[metalsmith-badge]: https://img.shields.io/badge/metalsmith-core_plugin-green.svg?longCache=true
[metalsmith-url]: https://metalsmith.io
[codecov-badge]: https://img.shields.io/coveralls/github/metalsmith/~core-plugin~
[codecov-url]: https://coveralls.io/github/metalsmith/~core-plugin~
[license-badge]: https://img.shields.io/github/license/metalsmith/~core-plugin~
[license-url]: LICENSE