metalsmith-md-summary v0.0.1

metalsmith-md-summary

A Metalsmith plugin to extract a summary from Markdown files. Useful for blog posts.

Install

$ npm install metalsmith-md-summary

Or

$ yarn add metalsmith-md-summary

Usage

const summary = require('metalsmith-md-summary')

metalsmith.use(summary())

By default metalsmith-md-summary will take Markdown files and look for the READMORE keyword on an otherwise empty paragraph. If it finds it, it will set the summary property on that file with all the content up to that keyword. If it doesn't, it will set the first non-empty paragraph as the file's summary.

Options

pattern (default '**/*.@(md|markdown)')

Files for which to generate a summary.

keyword (default 'READMORE')

Keyword to use as a delimiter for the summary.