bloggy-summary

A summary generator for blog posts in bloggy, a small and lightweight blog engine for node.js.

Quickstart

That's everything you need. Just call the engine.extendWith() function of the bloggy engine. But please ensure to register bloggy-summary with extendWith() after you've registerd a rendering engine like bloggy-marked.

var engine = require('bloggy')();

engine.extendWith(require('bloggy-summary'));

After the content of a blog entry is read, it has to new fields.

• summary contains the html encoded summary up to the defined maximum length (see below)
• metaDescription contains a text-only representation (" is replaced with ') up to a length of about 180 characters. This information can be used to fill the <meta name="description" content="......."> tag.

Additional options

You're able to change the following settings.

var engine = require('bloggy')(),
    bloggySummary = require('bloggy-summary');

// Shown values are the default values
bloggySummary.maxLength = 300;       // The maximum number of characters for the html-encoded, text-only summary snippet.
bloggySummary.prefix = '<p>';        // Prepends some text or unencoded strings
bloggySummary.suffix = ' ...<p>';    // Appends some text or unencoded strings

engine.extendWith(bloggySummary);

License

The MIT License (MIT)

Copyright (c) 2014 Marcell Spies

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.