Git Product home page Git Product logo

metalsmith-simple-excerpt's Introduction

metalsmith-simple-excerpt

A Metalsmith Plugin to create excerpts from file contents. Reads the first parts of the content Buffer, creates a subset of words and saves them to the file.

Installation

Install via git:

$ git clone https://github.com/kevingimbel/metalsmith-simple-excerpt node_modules/metalsmith-simple-excerpt

Install with npm

$ npm install metalsmith-simple-excerpt

Usage

Plug the excerpt into your Metalsmith pipeline. Important simpleExcerpt must be called before transforming the markdown files!

var simpleExcerpt = require('metalsmith-simple-excerpt');

var ms = Metalsmith(__dirname);
ms.use(simpleExcerpt({
  size: 50,
  bufferSize: 300,
  encoding: 'utf-8'  
});

Options

Name Type Default Description
size Integer 50 Count of returned words.
bufferSize Integer 300 Buffer length to read from
encoding String utf-8 Desired file Encoding

metalsmith-simple-excerpt's People

Contributors

kevingimbel avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.