poet-for-express-4
v1.1.2
Published
quick and easy blog module, using markdown, jade, whatever
Downloads
11
Maintainers
Readme
Poet for Express 4
#Deprecated fork jsantell/poet 2.0 supports Express 4 redering this fork obsolete
This is a fork of jsantell/poet that supports Express 4. Express 3 and below are not supported by this fork.
Poet has your code-blogging back. Renders markdown, jade, or any templated files as posts, tag it up with metadata that's passed into any view engine you want, instant pagination, tag and category views, and home in time for dinner.
View the source for jsantell.com to see an example of Poet in use. Much <3
to Brittany Fedor for the sweet art!
New Release
v1.1.0
Documentation
Full documentation for Poet can be found at http://jsantell.github.io/poet
Poet In Action
These sites are using Poet for their blogging, check them out! Ping me, or send a PR if you too are using Poet in the wild.
- Yellow Pages Engineering
- BryanPaluch.com
- EffectiveIdea.com
- fictitious entry
- AndreasKlein.org
- Keyboardsurfer
- FightMagicRun
- Morgondag
- Vemdel - Raspberry Hunt
- jobZETA
Installing
npm install poet
Setup
Include Poet in your package.json and add it to your app, passing in your Express app and options. Call the init
method and routes will be set up!
var
express = require('express'),
app = express(),
Poet = require('poet-for-express-4');
var poet = Poet(app, {
posts: './_posts/',
postsPerPage: 5,
metaFormat: 'json'
});
poet.init().then(function () {
// ready to go!
});
/* set up the rest of the express app */
Development
To run tests, run npm test
from the project root to run the Mocha tests. Generate documentation by updating the docs.md
and running make
.
Contributing
Please read the CONTRIBUTING.md for guides on contributions.
License
MIT License, Copyright (c) 2012 Jordan Santell