Note: This is a template repository
Usage:
- 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
- Search and replace all
core-plugin
CorePlugin
andcorePlugin
matches with the name of the plugin - Change description in package.json & match in repo description
- Remove this text
A metalsmith plugin to...
An optional features section (if there are many), or an extended description of the core plugin
NPM:
npm install @metalsmith/~core-plugin~
Yarn:
yarn add @metalsmith/~core-plugin~
Pass @metalsmith/~core-plugin~
to metalsmith.use
:
import ~corePlugin~ from '@metalsmith/~core-plugin~'
metalsmith.use(~corePlugin~()) // defaults
metalsmith.use(~corePlugin~({ // explicit defaults
...
}))
Optional section with list or table of options, if the plugin has a lot of options
Document a first specific usage example, the title can be "Achieve x by doing y"
Document a second specific usage example, the title can be "Achieve x by doing y"
To enable debug logs, set the DEBUG
environment variable to @metalsmith/~core_plugin~*
:
metalsmith.env('DEBUG', '@metalsmith/~core_plugin~*')
Alternatively you can set DEBUG
to @metalsmith/*
to debug all Metalsmith core plugins.
To use this plugin with the Metalsmith CLI, add @metalsmith/~core-plugin~
to the plugins
key in your metalsmith.json
file:
{
"plugins": [
{
"@metalsmith/~core-plugin~": {}
}
]
}
Special thanks to ... for ...