https://github.com/marcells/bloggy-summary

A summary generator for blog posts in bloggy, a small and lightweight node.js blog engine.
https://github.com/marcells/bloggy-summary

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/marcells/bloggy-summary
• Owner: marcells
• Created: 2014-05-07T23:29:34.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2016-01-21T23:57:47.000Z (almost 9 years ago)
• Last Synced: 2024-08-11T08:28:48.548Z (3 months ago)
• Language: JavaScript
• Size: 4.88 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

README

        
# 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`.

```Javascript

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 `` tag.

## Additional options

You're able to change the following settings.

```Javascript

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 = '
';        // Prepends some text or unencoded strings

bloggySummary.suffix = ' ...
';    // 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.