metalsmith-collections-offset
v1.0.1
Published
Offset items in a Metalsmith collection.
Downloads
61
Maintainers
Readme
metalsmith-collections-offset
A plugin to offset items in a Metalsmith collection.
Features
- removes x items from beginning of collection using
offset
- removes x items from end of collection using
-offset
Installation
$ npm install --save-dev metalsmith-collections-offset
Usage
Configure your build
import offsetCollections from 'metalsmith-collections-offset'
metalsmith
.use(collections())
.use(offsetCollections({
articles: 1
}))
Remove first n items from collection
metalsmith.use(offsetCollections({
[collectionName]: n
}))
Remove last n items from collection
metalsmith.use(offsetCollections({
[collectionName]: -n
}))
CLI Usage
{
"plugins": {
"metalsmith-collections-offset": {
"articles": 1
}
}
}
License
MIT License
Copyright (c) 2017 Yann Eves <[email protected]>
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.