Plugin registry
Metalsmith.js plugin registry Submit yours
Algolia
A metalsmith plugin for indexing contents on Algolia.
npm i metalsmith-algolia
Alias
Create URL aliases for any page.
npm i metalsmith-alias
Ancestry
Builds a file tree in metadata so you can determine parents, list children, jump to previous and next siblings.
npm i metalsmith-ancestry
Angular $templateCache
Convert AngularJS templates from HTML into JavaScript and preload $templateCache.
npm i metalsmith-angular-templatecache
Archive
Create an archives page organized by date fields.
npm i metalsmith-archive
Asciidoctor
Plugin to transform AsciiDoc files to HTML using asciidoctor.js
npm i metalsmith-asciidoctor
Assert
Test file objects with assert.
npm i metalsmith-assert
Assets
Include static assets in your build.
npm i metalsmith-assets
Atomizer
Automatically generate Atomic CSS from HTML using Atomizer.
npm i metalsmith-atomizer
Author
Include authors information in collection files.
npm i metalsmith-author
Auto Collections
Automatically use metalsmith-collections based on the filesystem.
npm i metalsmith-auto-collections
Autoprefixer
Automatically add vendor prefixes to CSS.
npm i metalsmith-autoprefixer
Beautifier
Nicely format your html, css or js files.
npm i metalsmith-beautify
Bibtex
Load and render bibtex bibliographies.
npm i metalsmith-bibtex
Bitly
Add bitly links to the metadata of each file.
npm i metalsmith-bitly
Bookify HTML
Combine multiple HTML files into one. Updates links and images.
npm i metalsmith-bookify-html
Branch
Run separate metalsmith pipelines on selected files.
npm i metalsmith-branch
Broken Link Checker
Check for relative and root-relative broken links.
npm i metalsmith-broken-link-checker
Brotli
Compress files with brotli.
npm i metalsmith-brotli
Browser Sync
Leverage Browser Sync for an easier development workflow.
npm i metalsmith-browser-sync
Browserify
Compile Javascript with browserify.
npm i metalsmith-browserify
Build Date
Add a build date, for things like feeds or sitemaps.
npm i metalsmith-build-date
Build Info
Adds metadata about the build environment (build date, user, Node.js version, platform and more)
npm i metalsmith-build-info
Changed
Process only files that have changed.
npm i metalsmith-changed
Check All Links
Check all links, both internal and external, in anchors, images, and external page resources.
npm i metalsmith-linkcheck
Clean CSS
Minify your CSS Files.
npm i metalsmith-clean-css
Clean Script
Generate a script to cleanup the build directory, if you are adding more than just Metalsmith files.
npm i metalsmith-cleanscript
Cloudfront
Invalidate Amazon CloudFront cache. Best used in conjunction with the metalsmith-s3 plugin.
npm i metalsmith-cloudfront
Code Highlight
Syntax highlighting for code within Markdown and HTML files.
npm i metalsmith-code-highlight
Coffee
Compile CoffeeScript files to Javascript.
npm i metalsmith-coffee
Collection Metadata
Add metadata to every file in a collection
npm i metalsmith-collection-metadata
Collections
Group files together, like blog posts. That way you can loop over them to generate an index, or add 'next' and 'previous' links between them.
npm i @metalsmith/collections
Collections Related
Find related files within collections.
npm i metalsmith-collections-related
Concat
Concatenate your files.
npm i metalsmith-concat
Concat Convention
Concatenate your files through file conventions, rather than configuration.
npm i metalsmith-concat-convention
Contentful
Create static sites with data stored at Contentful.com
npm i contentful-metalsmith
Convert
Convert image files with imagemagick.
npm i metalsmith-convert
Copy
Copy and rename files.
npm i metalsmith-copy
Creation and Update Timestamps
Add creation and updated timestamps
npm i metalsmith-updated
CSS Unused
Remove unused CSS rules.
npm i metalsmith-css-unused
Data Loader
Load JSON/YAML files into the metadata of files from within your source tree or a models folder.
npm i metalsmith-data-loader
Data Markdown
Use markdown content within html tags via data-markdown attribute.
npm i metalsmith-data-markdown
Date in filename
Enrich file metadata with dates present in source filenames.
npm i metalsmith-date-in-filename
Date Formatter
Format dates defined in the YAML Front Matter
npm i metalsmith-date-formatter
Debug UI
Render a nice browser based ui to inspect build files & meta.
npm i metalsmith-debug-ui
Default Values
Sets default values to frontmatter metadata if they don't exist.
npm i @metalsmith/default-values
Define
Manually define values in the metadata.
npm i metalsmith-define
Discover Helpers
Discovers your template helpers and registers them with Handlebars.
npm i metalsmith-discover-helpers
Discover Partials
Discovers your template partials and registers them with Handlebars.
npm i metalsmith-discover-partials
Disqus
Adds Disqus comments widget and counter.
npm i metalsmith-disqus
Dither
Make a dithered copy of images.
npm i metalsmith-dither
Drafts
Hide any files marked as drafts.
npm i @metalsmith/drafts
Duo
Compile assets with Duo.
npm i metalsmith-duo
Each
Easily apply a function to each file or filename.
npm i metalsmith-each
Eslint
Eslint your JavaScript files.
npm i metalsmith-eslint
Elevate
Bump files up one or more directories.
npm i metalsmith-elevate
Encode HTML
Easily encode HTML entities in any HTML file by surrounding target code in triple backticks.
npm i metalsmith-encode-html
Env
Register all environment variables as metadata.
npm i metalsmith-env
Etsy
Incorporate your active Etsy shop data into a static website.
npm i metalsmith-etsy
Excel-Markdown
Query Excel files with SQL and convert to Markdown tables.
npm i metalsmith-excel-markdown
Except
Omit attributes from each file's metadata.
npm i metalsmith-except
Excerpts
Extract the first paragraph from the beginning of any HTML file.
npm i @metalsmith/excerpts
Express
Serve static files with express, built-in support for liveReload.
npm i metalsmith-express
Favicons
A Metalsmith favicons generator.
npm i metalsmith-favicons
Feed
Generate an RSS feed for a collection.
npm i metalsmith-feed
Feed Atom
Generate Atom feed for a collection.
npm i metalsmith-feed-atom
File Metadata
Add metadata on files based on a pattern.
npm i metalsmith-filemetadata
File Transform
Allows quick manipulation of the file object.
npm i metalsmith-transform
Fingerprint
Insert a hash of the content into the file name.
npm i metalsmith-fingerprint
Flatten
Flatten a directory hierarchy.
npm i metalsmith-flatten
Frontmatter File Loader
Iterate through the properties of a frontmatter object and for each property replace the value with the string contents of a utf-8 encoded file resolved using the original value as a file path.
npm i metalsmith-frontmatter-file-loader
Frontmatter Renderer
Iterate through the properties of a frontmatter object and for each property render the value using a jstransformer and replace it.
npm i metalsmith-frontmatter-renderer
Project images
Scan images in specified subfolder and add it to metadata.
npm i metalsmith-project-images
Gallery
Scan for images in folders and add them to metadata.
npm i metalsmith-scan-images
Gather Content
Generate sites from Gather Content projects
npm i metalsmith-gathercontent
Gist
Lets you get gists from Github Gist
npm i metalsmith-gist
GitHub Markdown
Convert markdown with Github Markdown API.
npm i metalsmith-github-markdown
GitHub Profile
Fetch GitHub profile information.
npm i metalsmith-github-profile
Google Analytics
Adds the Google Analytics script to your html files
npm i metalsmith-google-analytics
Google Drive
Scrape files from Google Drive.
npm i metalsmith-google-drive
Google Sheets
Pull in data from a google spreadsheet using the API.
npm i metalsmith-google-sheets
Gravatar
Pull in images from Gravatar.com.
npm i metalsmith-gravatar
gulp-metalsmith
A lightweight plugin that incorporates Metalsmith builds into gulp pipelines.
npm i gulp-metalsmith
Gulpsmith
Use Gulp plugins in Metalsmith, or Metalsmith as a Gulp plugin. Useful for uploading files, reading less than an entire directory tree, using external front matter, etc.
npm i gulpsmith
Gzip
Compress files with gzip.
npm i metalsmith-gzip
Handlebars Contents
Process Mustache syntax in file contents using Handlebars. Safe for live reloading.
npm i metalsmith-handlebars-contents
Handlebars Layouts
Wrap files in layouts, leveraging Mustache syntax via Handlebars. Safe for live reloading.
npm i metalsmith-handlebars-layouts
Handlebars in Markdown
Process Handlebars in Markdown files.
npm i metalsmith-hbt-md
Handlebars X
Full Handlebars integration. Global/local partials, in-place & layout compilation, and maximum flexibility.
npm i metalsmith-handlebars-x
Headings
Extract headings from HTML files and attach them to the file's metadata. Useful for automatically building navigation for a document.
npm i metalsmith-headings
Headings Identifier
Add an id and anchor to all headings on a page. Ideal for permalinks.
npm i metalsmith-headings-identifier
Hooks
Add page-specific hooks (like mini-plugins) to your build
npm i metalsmith-hooks
htaccess
Create an Apache HTTP Server .htaccess configuration file.
npm i metalsmith-htaccess
HTML5 Format Checker
Use html-validator to validate your HTML.
npm i metalsmith-formatcheck
HTML Glob
Apply glob patterns within HTML.
npm i metalsmith-html-glob
HTML Linter
Lint HTML for syntax and semantics.
npm i metalsmith-html-linter
HTML Minifier
Minify your HTML files.
npm i metalsmith-html-minifier
HTML Relative
Convert to relative paths within HTML.
npm i metalsmith-html-relative
HTML Subresource Integrity
Add subresource integrity attributes to HTML.
npm i metalsmith-html-sri
HTML Tidy
Tidy your HTML files to make your source beautiful.
npm i metalsmith-html-tidy
HTML Unused
Exclude resources that aren't referenced in HTML files.
npm i metalsmith-html-unused
Hyphenate
Use Hypher hyphenation engine in your HTMLs.
npm i metalsmith-hyphenate
i18n
Translate your strings.
npm i metalsmith-i18n
i18next
Easily create multiple localised branches of your site using the excellent i18next library.
npm i metalsmith-i18next
If
Run plugins in the build sequence conditionally.
npm i metalsmith-if
Reading Time
Estimate pages' reading times.
npm i metalsmith-reading-time
Remove
A Metalsmith plugin to remove files from the build
npm i @metalsmith/remove
Image Aspect Ratio
A plugin for adding image aspect ratios, fixing Cumulative Layout Shifts.
npm i metalsmith-image-aspect-ratio
Imagemin
A Metalsmith plugin to minify images using imagemin.
npm i metalsmith-imagemin
Image Resizer
An image resizing plugin for Metalsmith. Not dependent on imagemagick/graphicsmagick!
npm i metalsmith-image-resizer
In-place
In-place templating, render templates in your source files.
npm i metalsmith-in-place
Include
Make other source files available as properties.
npm i metalsmith-include
Include Content
Allows content to be included (nested) within other content by including the file path
npm i metalsmith-include-content
Include Files
Include external files in your build.
npm i metalsmith-include-files
Inject Metadata
Inject metadata constants into source file data.
npm i metalsmith-inject-metadata
Inline CSS
Inline CSS files, including those generated by preprocessors
npm i metalsmith-inline-css
Inline Source
Inlines static assets like SVG, Javascript and CSS
npm i metalsmith-inline-source
Inline SVG
Inlines SVG images into your HTML files
npm i metalsmith-inline-svg
Inspect
Print/inspect the file objects, mainly for debugging.
npm i metalsmith-inspect
Hover
Display image and gif links on mouse hover.
npm i metalsmith-hover
Icons
Automatically generate icon font files using Fontello.
npm i metalsmith-icons
Incremental
Faster incremental builds for Metalsmith.
npm i metalsmith-incremental
Index
A plugin to create directory indexes.
npm i metalsmith-index
JavaScript packer
JavaScript packer/minifier/uglifier for Metalsmith
npm i metalsmith-js-packer
Jekyll Dates
Automatically extract dates from Jekyll-style filenames.
npm i metalsmith-jekyll-dates
jQuery
Manipulate your HTML files with jQuery.
npm i metalsmith-jquery
JSON
Parse .json files and make their properties available to downstream plugins.
npm i metalsmith-json
JSON to files
Creates files from the properties within .json files with filename patterns and permalinks.
npm i metalsmith-json-to-files
JSON insteadof Markdown
Use JSON files in addition to markdown files to write your content
npm i @boeckmt/metalsmith-json-insteadof-md
JSTransformer
Compile content with any JSTransformer.
npm i metalsmith-jstransformer
JSTransformer Partials
Provide `partial` helpers with any JSTransformer.
npm i metalsmith-jstransformer-partials
Just A Moment
A Metalsmith plugin to auto convert dates to moment objects.
npm i metalsmith-just-a-moment
Keymaster
Flexible, powerful manipulation of key-value pairs in file metadata.
npm i metalsmith-keymaster
Layouts
Apply layouts to your source files.
npm i @metalsmith/layouts
LESS
Convert LESS files to CSS.
npm i metalsmith-less
Link Checker
Check for local and remote broken links.
npm i metalsmith-link-checker
Link Globs
Instead of manually adding links to files, repeat your script, link, img and a tags by using globs.
npm i metalsmith-link-globs
Lunr Search
Implement Lunr.js client-side search engine.
npm i metalsmith-lunr
Markdown
Convert Markdown files to HTML.
npm i @metalsmith/markdown
Markdown-it
Convert Markdown files to HTML using markdown-it.
npm i metalsmith-markdownit
Markdown-Partials
Enables the use of Markdown partials, e.g. Markdown fragments can be inserted into the contents section of a page markdown file via an include marker.
npm i metalsmith-markdown-partials
Markdown-Remarkable
Convert Markdown files to HTML using Remarkable.
npm i metalsmith-markdown-remarkable
Mingo
Wrapper for the Mingo library which allows to make MongoDB style queries.
npm i metalsmith-mingo
Mithril
Convert mithril.js Javascript files to html.
npm i metalsmith-mithril
Multi Language
Adds multi-language support to your projects.
npm i metalsmith-multi-language
MultiMarkdown
Convert Markdown files to HTML using MultiMarkdown-4 syntax.
npm i metalsmith-multimarkdown
Mermaid
Render Mermaid diagrams in files.
npm i metalsmith-mermaid
Metadata
Load metadata from JSON or YAML files.
npm i metalsmith-metadata
Metadata Directory
Add a directory of JSON files for use in templates and pages.
npm i metalsmith-metadata-directory
Metafiles
Read file metadata from separate files (as an alternative to frontmatter).
npm i metalsmith-metafiles
Metallic
Highlight code in markdown files with highlight.js.
npm i metalsmith-metallic
Metalsmith Matters
Read file metadata from frontmatter.
npm i metalsmith-matters
Metalsmith Tracer
Automatically trace and measure Metalsmith build time.
npm i metalsmith-tracer
Moment
Converts file metadata to moment.js object
npm i metalsmith-moment
More
Stores the content before the "more" comment tag in HTML files.
npm i metalsmith-more
Move/Remove
Moves and/or removes files in the file structure.
npm i metalsmith-move-remove
Mustache Metadata
Modifies metadata to make it more useful in Mustache templates. Adds easy conditions and links to parent objects.
npm i metalsmith-mustache-metadata
Myth
Preprocess CSS files with Myth.
npm i metalsmith-myth
Move Up
Move whole directories and their contents up one or more levels.
npm i metalsmith-move-up
Native Lazy Loading
A plugin that adds browser native lazy loading to images.
npm i metalsmith-native-lazy-loading
Navigation
Generate navigation based on file trees
npm i metalsmith-navigation
nested
A metalsmith plugin for nesting your layouts when using the handlebars engine.
npm i metalsmith-nested
ng-annotate
Add, remove and rebuild AngularJS dependency injection annotations.
npm i metalsmith-ng-annotate
npm
Include npm modules in your globals
npm i metalsmith-npm
Only
Filter out attributes from each file's metadata.
npm i metalsmith-only
Open Graph
Add Facebook Open Graph meta tags to HTML.
npm i metalsmith-open-graph
OptiPng
Metalsmith wrapper for optipng - to optimize and make your png images smaller
npm i metalsmith-optipng
org
Convert org-mode files to HTML.
npm i metalsmith-org
PackageJSON
Parses the contents of package.json and makes them available in a global 'pkg'
npm i
Paths
adds file path values (dirname, extname, basename, path) to metadata
npm i metalsmith-paths
Partial
Provide 'partial' helper to include other files.
npm i metalsmith-partial
Paginate
A simple plugin that uses metalsmith-collections to create a paginated collection.
npm i metalsmith-paginate
Pagination
Paginate arrays and collections into multiple files.
npm i metalsmith-pagination
Pandoc
Convert files with pandoc.
npm i metalsmith-pandoc
PDF
Convert HTML files to PDF using wkhtmltopdf
npm i metalsmith-pdf
PDFize
Export HTML files to PDF using Headless Chrome
npm i metalsmith-pdfize
Page Title
Add a global site title to every `<title>` tag.
npm i metalsmith-page-titles
Perma
An alternative to metalsmith-permalinks allowing for custom permalinks and overrides.
npm i metalsmith-perma
Permalinks
Apply custom permalinks and rename files to be nested properly for static sites, basically converting `about.html` into `about/index.html`.
npm i @metalsmith/permalinks
Picset Generate
Gives responsive image resolution choices. Generates image sets for use with the Picset Handlebars Helper plugin
npm i metalsmith-picset-generate
Picset Handlebars Helper
Uses generated responsive image resolutions. Those generated by the Picset Generate plugin display in browser via a `<picture>` element
npm i metalsmith-picset-handlebars-helper
Polyglot
Simple mirror translations for blog-like entries.
npm i metalsmith-polyglot
PostCSS
A Metalsmith plugin for PostCSS.
npm i metalsmith-with-postcss
Placeholder
Stub content-less files from JSON/Yaml metadata files
npm i metalsmith-placeholder
Preview
Generate custom text previews saved to file metadata.
npm i metalsmith-preview
Prism Syntax Highlighting
Syntax highlighting for HTML templates using Prism.js.
npm i metalsmith-prism
Prismic
Create static sites with data stored at Prismic.io
npm i metalsmith-prismic
Projects
Adds metadata for projects (think portfolio content) from GitHub or filesystem (through collections) that can be looped over for creating a portfolio of work.
npm i metalsmith-projects
Prompt
Prompt the user for series of answers in the command line and add them to the global metadata.
npm i metalsmith-prompt
Propdown
A metalsmith plugin to convert a property value from markdown to HTML.
npm i metalsmith-propdown
Publish
Declare files as draft, private, or future-dated and use callback to automate rebuilds.
npm i metalsmith-publish
Pug (Jade)
Convert Pug (previously Jade) files to HTML.
npm i metalsmith-pug
PurifyCSS
Remove unused CSS.
npm i metalsmith-purifycss
React Templates
Render any file using React JS based component templates
npm i metalsmith-react-templates
React tpl
Use React in metalsmith as a templating language
npm i metalsmith-react-tpl
Redirect
A simple plugin to create client-side HTTP redirections.
npm i metalsmith-redirect
Regex Replace
Performs search and replace in text source files
npm i metalsmith-regex-replace
Relative Links
Adds a link function into your metadata so templates can link resources easier.
npm i metalsmith-relative-links
Renamer
Rename files matching a given pattern.
npm i metalsmith-renamer
Replace
Replace attribute values in each file's metadata.
npm i metalsmith-replace
Rework
Use rework CSS processor to rework your files.
npm i metalsmith-rework
Rho
Convert Rho files to HTML.
npm i metalsmith-rho
Request
Grab content from the web and expose the results to metadata.
npm i metalsmith-request
Rollup
Bundle JavaScript with Rollup.
npm i metalsmith-rollup
Root Path
Auto-calculate the relative path to your root directory in template urls.
npm i metalsmith-rootpath
S3
Copy, read, and write files on Amazon S3.
npm i metalsmith-s3
Sass
Convert Sass files to CSS.
npm i @metalsmith/sass
Sass
Convert Sass files to CSS.
npm i metalsmith-sass
Sass lint
Stylelint your Sass files.
npm i metalsmith-sass-lint
Series
Groups files into series for easier navigation
npm i metalsmith-series
Serve
Simple http server for development. Best used with metalsmith-watch.
npm i metalsmith-serve
Sharp
Use the powerful sharp library to resize and manipulate your images.
npm i metalsmith-sharp
Shortcodes
Render wordpress-esque shortcodes via templates.
npm i metalsmith-shortcodes
Shortcode Parser
A metalsmith wrapper for shortcode-parser.
npm i metalsmith-shortcode-parser
Sitemap
A metalsmith plugin for generating a sitemap.xml file.
npm i metalsmith-sitemap
Skeleton Gallery
Generate an image gallery, using the Skeleton CSS framework.
npm i metalsmith-skeleton-gallery
Slug
Add a slug property to file metadata, based on a another property.
npm i metalsmith-slug
Snippet
Extract snippets from files, limited by a maximum number of characters.
npm i metalsmith-snippet
Spell Checking
Spell check your site.
npm i metalsmith-spellcheck
Static
Copy public assets into the build directory.
npm i metalsmith-static
Stylesheet Packer
CSS packer/minifier/optimizer for Metalsmith.
npm i metalsmith-css-packer
Stylus
Convert Stylus files to CSS.
npm i metalsmith-stylus
Subresource Integrity
Generate integrity hashes for site resources.
npm i metalsmith-subresource-integrity
Sugar
Use a shorthand when including plugins and avoid calling require() on each individual module.
npm i metalsmith-sugar
SUITCSS
Preprocess CSS files with SUITCSS.
npm i metalsmith-suitcss
Swig Helpers
Useful bits for those of us using swig
npm i metalsmith-swig-helpers
Symlink
Create Symlinks for large files or directories.
npm i metalsmith-symlink
Table of Contents
Auto-generate table of contents from headings
npm i table-of-contents
Tags
Generate tag listing pages based on tags provided in pages.
npm i metalsmith-tags
Taxonomy
Organize files into taxonomies in global metadata and auto-generate taxonomy pages (tags, post types, products)
npm i metalsmith-taxonomy
Timer
Clock how long it takes for plugins in your build sequence to run.
npm i metalsmith-timer
Timestamp
Add timestamp comment to html files
npm i metalsmith-timestamp
Textile
Convert Textile to HTML
npm i metalsmith-textile
To JSON
Generates JSON files from markdown, preserving filenames and frontmatter.
npm i metalsmith-to-json
Tweet Embed
Converts Twitter status URLS to embedded Twitter statuses
npm i metalsmith-tweet-embed
Twig
Renders all files with the Twig template engine.
npm i metalsmith-twig
Twitter Card
Adds Twitter Card meta tags to enable Twitter share rich snippets.
npm i metalsmith-twitter-card
Typography
Enhance typography in HTML files.
npm i metalsmith-typography
Uglify
Uglifies/minifies your JavaScript files
npm i metalsmith-uglify
UnCSS
Remove unused CSS rules with UnCSS
npm i metalsmith-uncss
Unlisted
Remove pages from collections, but still allow them to build
npm i metalsmith-unlisted
Validate
Easily validate file metadata, checking existence, type, and pattern.
npm i metalsmith-validate
Watch
Watching for file changes and trigger rebuilds.
npm i metalsmith-watch
Webpack
Bundle CommonJS, AMD and ES6 modules.
npm i metalsmith-webpack
Webpack 2
Webpack 2, with cache.
npm i metalsmith-webpack-2
Word Count
Compute wordcount and average reading time.
npm i metalsmith-word-count
Write Metadata
Write the metadata excerpted from the files to the filesystem as json files.
npm i metalsmith-writemetadata
XO
XO lint your JavaScript files.
npm i metalsmith-xo
YouTube
A Metalsmith plugin that lets you embed YouTube Videos.
npm i metalsmith-youtube
Submit your plugin
Plugins in the official registry get higher visibility than those only published on Github or NPM, and they must pass a brief quality review. Guidelines for plugins to be accepted in the registry are:
- The package is published in the NPM registry
- The package includes at least 1 test
- The package provides functionality that is different from already registered plugins. Why? — because we want to encourage collaboration and reduce the amount of confusion for new metalsmith users.
Edit the plugins.json file and create a pull request to get your plugin listed. Plugins need to be added at the correct alphabetical position by name
: if your plugin’s name is “b”, it should come right after the plugin named “a”.
Add a plugin object to the list with the following properties:
{
"name": "My plugin",
"icon": "icon-name",
"repository": "https://github.com/username/metalsmith-myplugin",
"description": "Metalsmith plugin for doing something.",
"npm": "@myscope/metalsmith-myplugin"
},
where:
name
- should match the NPM package or repository name, but can be in title case & with spacesicon
- one of the Metalsmith icons, preferably matching what the plugin doesrepository
- url to the repository of the plugin, e.g.https://github.com/username/metalsmith-myplugin
description
- a short description for the plugin, ideally matchingpackage.json
or Github repository descriptionnpm
- optional, to specify a name different thanname
, e.g. for scoped NPM packages (@<myscope>/<metalsmith-myplugin>)