Skip to content

A Metalsmith plugin to add an excerpt to files.

Notifications You must be signed in to change notification settings

newlinedotco/metalsmith-absoluteurls

 
 

Repository files navigation

metalsmith-excerpts

npm version code style: xo metalsmith: core plugin

Known Vulnerabilities

A Metalsmith plugin to extract an excerpt from HTML files.

The excerpt is scraped from first paragraph (<p> tag) of the rendered HTML.

If a file already has an excerpt value, that value will be returned.

Installation

$ npm install metalsmith-excerpts

CLI Usage

Install via npm and then add the metalsmith-excerpts key to your metalsmith.json plugin, like so:

{
  "plugins": {
    "metalsmith-excerpts": true
  } 
}

Javascript Usage

var excerpts = require('metalsmith-excerpts');

metalsmith.use(excerpts());

License

MIT

About

A Metalsmith plugin to add an excerpt to files.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%