Nocturnal Practitioners of Magic
    Wondering what’s next for npm?Check out our public roadmap! »

    node-pluma

    1.0.2 • Public • Published

    The Pluma Logo

    Pluma

    Build Status

    NOTE: Pluma is a fork of the famous nodeJS blogging platform "Poet" from jsantell.

    Pluma has your code-blogging back. Renders markdown, pug, 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.

    Support

    Check the CHANGELOG.md for more information about support concerns.

    Documentation (TO-DO)

    Full documentation for Poet (Pluma's forked project) can be found at https://jsantell.github.io/poet

    Installing

    • yarn add node-pluma@version

    Setup

    Include Pluma in your package.json and add it to your app, passing in your Express app and options as arguments. Call the init method and routes will be set up!

    const express = require('express');
    const app = express();
    const Pluma = require('node-pluma');
     
    const pluma = Pluma(app, {
      posts: './_posts/',
      postsPerPage: 5,
      metaFormat: 'json'
    });
     
    pluma.init().then( () => {
      // ready to go!
    });
     
    /* set up the rest of the express app */

    Development

    To run tests, run yarn 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.

    Licenses

    • Poet: MIT License, Copyright (c) 2012 Jordan Santell
    • Pluma: MIT License, Copyright (c) 2018 Manuel Escudero

    Install

    npm i node-pluma

    DownloadsWeekly Downloads

    1

    Version

    1.0.2

    License

    MIT

    Unpacked Size

    424 kB

    Total Files

    86

    Last publish

    Collaborators

    • avatar